DashboardFederationDataSource Class

A federated data source that retrieves data from different data sources.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v19.2.Core.dll

Declaration

C#
VB.NET

public class DashboardFederationDataSource :
    FederationDataSourceBase,
    IDashboardDataSource,
    IDashboardComponent,
    IComponent,
    IDisposable,
    ISupportInitialize,
    ISupportPrefix,
    IDashboardDataSourceInternal,
    ICloneable<DashboardFederationDataSource>,
    IAssignable<DashboardFederationDataSource>,
    IQueryDataSource<QueryNode>,
    IExternalSchemaConsumer

Public Class DashboardFederationDataSource
    Inherits FederationDataSourceBase
    Implements IDashboardDataSource,
               IDashboardComponent,
               IComponent,
               IDisposable,
               ISupportInitialize,
               ISupportPrefix,
               IDashboardDataSourceInternal,
               ICloneable(Of DashboardFederationDataSource),
               IAssignable(Of DashboardFederationDataSource),
               IQueryDataSource(Of QueryNode),
               IExternalSchemaConsumer

Remarks

You can create a query that combines multiple data sources to provide uniform access. This query forms the federated data source which operates with the source-specific query language, translates the queries, and processes the results to supply a dashboard with data. A federated data source does not support OLAP data sources.

Tip

Demo: Data Federation

Requires installation of Universal Subscription. Download

Create a DashboardFederationDataSource instance and add it to the Dashboard.DataSources collection.

The data source obtains its data from federated queries contained in the Queries collection.

Note

In Async mode, if the FederationDataSource includes the DashboardObjectDataSource, make sure that the DashboardObjectDataSource gets data in the AsyncDataLoading event handler and do not call the DashboardObjectDataSource.Fill and FederationDataSource.Fill methods.

Example

Note

The complete sample project How to Bind a Dashboard to a Federated Data Source Created at Runtime is available in the DevExpress Examples repository.

C#
VB.NET

using DevExpress.DashboardCommon;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.DataFederation;
using DevExpress.DataAccess.Excel;
using DevExpress.DataAccess.Sql;
// ...
DashboardFederationDataSource federatedDS = CreateFederatedDataSource(sqliteDataSource, exceldataSource, objectDataSource);
dashboard.DataSources.Add(federatedDS);

private static DashboardFederationDataSource CreateFederatedDataSource(DashboardSqlDataSource sqliteDataSource, DashboardExcelDataSource exceldataSource, DashboardObjectDataSource objectDataSource)
{
    DashboardFederationDataSource federationDS = new DashboardFederationDataSource();
    Source sqlSource = new Source("sqlite", sqliteDataSource, "SQLite Orders");
    Source excelSource = new Source("excel", exceldataSource, "");
    Source objectSource = new Source("SalesPersonDS", objectDataSource, "");

    #region Use-API-to-create-a-query
    SelectNode mainQueryCreatedByApi = new SelectNode();

    SourceNode excelSourceNode = new SourceNode(excelSource, "ExcelDS");
    SourceNode objectSourceNode = new SourceNode(objectSource, "ObjectDS");
    SourceNode sqliteSourceNode = new SourceNode(sqlSource, "SQLite Orders");

    mainQueryCreatedByApi.Alias = "FDS-Created-by-API";
    SourceNode root = new SourceNode(sqlSource, "SQLite Orders");
    mainQueryCreatedByApi.Root = root;
    mainQueryCreatedByApi.Expressions.Add(new SelectColumnExpression() { Name = "SalesPerson", Node = objectSourceNode });
    mainQueryCreatedByApi.Expressions.Add(new SelectColumnExpression() { Name = "Weight", Node = objectSourceNode });
    mainQueryCreatedByApi.Expressions.Add(new SelectColumnExpression() { Name = "CategoryName", Node = excelSourceNode });
    mainQueryCreatedByApi.Expressions.Add(new SelectColumnExpression() { Name = "ProductName", Node = excelSourceNode });
    mainQueryCreatedByApi.Expressions.Add(new SelectColumnExpression() { Name = "OrderDate", Node = sqliteSourceNode });
    mainQueryCreatedByApi.Expressions.Add(new SelectColumnExpression() { Name = "ShipCity", Node = sqliteSourceNode });
    mainQueryCreatedByApi.Expressions.Add(new SelectColumnExpression() { Name = "ShipCountry", Node = sqliteSourceNode });
    mainQueryCreatedByApi.Expressions.Add(new SelectColumnExpression() { Name = "Extended Price", Node = excelSourceNode });
    mainQueryCreatedByApi.SubNodes.Add(new JoinElement(excelSourceNode, JoinType.Inner, "[ExcelDS.OrderID] = [SQLite Orders.OrderID]"));
    mainQueryCreatedByApi.SubNodes.Add(new JoinElement(objectSourceNode, JoinType.Inner, "[ObjectDS.SalesPerson] = [ExcelDS.Sales Person]"));
    #endregion

    #region Use-NodedBuilder-to-create-a-query
    SelectNode mainQueryCreatedByNodeBuilder =
        sqlSource.From()
        .Select("OrderDate", "ShipCity", "ShipCountry")
        .Join(excelSource, "[excel.OrderID] = [sqlite.OrderID]")
            .Select("CategoryName", "ProductName", "Extended Price")
            .Join(objectSource, "[SalesPersonDS.SalesPerson] = [excel.Sales Person]")
                .Select("SalesPerson", "Weight")
                .Build("FDS-Created-by-NodeBulder");
    #endregion

    federationDS.Queries.Add(mainQueryCreatedByNodeBuilder);
    federationDS.Queries.Add(mainQueryCreatedByApi);

    federationDS.CalculatedFields.Add("FDS-Created-by-NodeBulder", "[Weight] * [Extended Price] / 100", "Score");

    federationDS.Fill(new DevExpress.Data.IParameter[0]);
    return federationDS;
}

Imports DevExpress.DashboardCommon
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.DataFederation
Imports DevExpress.DataAccess.Excel
Imports DevExpress.DataAccess.Sql
' ...
Private Shared Function CreateFederatedDataSource(ByVal sqliteDataSource As DashboardSqlDataSource, ByVal exceldataSource As DashboardExcelDataSource, ByVal objectDataSource As DashboardObjectDataSource) As DashboardFederationDataSource
    Dim federationDS As New DashboardFederationDataSource()
    Dim sqlSource As New Source("sqlite", sqliteDataSource, "SQLite Orders")
    Dim excelSource As New Source("excel", exceldataSource, "")
    Dim objectSource As New Source("SalesPersonDS", objectDataSource, "")

#Region "Use-API-to-create-a-query"
    Dim mainQueryCreatedByApi As New SelectNode()

    mainQueryCreatedByApi.Alias = "FDS-Created-by-API"
    Dim root As New SourceNode(sqlSource, "SQLite Orders")
    Dim excelSourceNode As New SourceNode(excelSource, "ExcelDS")
    Dim objectSourceNode As New SourceNode(objectSource, "ObjectDS")

    mainQueryCreatedByApi.Root = root
    mainQueryCreatedByApi.Expressions.Add(New SelectColumnExpression() With {.Name = "SalesPerson", .Node = objectSourceNode})
    mainQueryCreatedByApi.Expressions.Add(New SelectColumnExpression() With {.Name = "Weight", .Node = objectSourceNode})
    mainQueryCreatedByApi.Expressions.Add(New SelectColumnExpression() With {.Name = "CategoryName", .Node = excelSourceNode})
    mainQueryCreatedByApi.Expressions.Add(New SelectColumnExpression() With {.Name = "ProductName", .Node = excelSourceNode})
    mainQueryCreatedByApi.Expressions.Add(New SelectColumnExpression() With {.Name = "OrderDate", .Node = root})
    mainQueryCreatedByApi.Expressions.Add(New SelectColumnExpression() With {.Name = "ShipCity", .Node = root})
    mainQueryCreatedByApi.Expressions.Add(New SelectColumnExpression() With {.Name = "ShipCountry", .Node = root})
    mainQueryCreatedByApi.Expressions.Add(New SelectColumnExpression() With {.Name = "Extended Price", .Node = excelSourceNode})
    mainQueryCreatedByApi.SubNodes.Add(New JoinElement(excelSourceNode, JoinType.Inner, "[ExcelDS.OrderID] = [SQLite Orders.OrderID]"))
    mainQueryCreatedByApi.SubNodes.Add(New JoinElement(objectSourceNode, JoinType.Inner, "[ObjectDS.SalesPerson] = [ExcelDS.Sales Person]"))
#End Region

#Region "Use-NodedBuilder-to-create-a-query"
    Dim mainQueryCreatedByNodeBuilder As SelectNode = sqlSource.From() _
        .Select("OrderDate", "ShipCity", "ShipCountry") _
        .Join(excelSource, "[excel.OrderID] = [sqlite.OrderID]") _
        .Select("CategoryName", "ProductName", "Extended Price") _
        .Join(objectSource, "[SalesPersonDS.SalesPerson] = [excel.Sales Person]").Select("SalesPerson", "Weight") _
        .Build("FDS-Created-by-NodeBulder")
#End Region

    federationDS.Queries.Add(mainQueryCreatedByNodeBuilder)
    federationDS.Queries.Add(mainQueryCreatedByApi)

    federationDS.CalculatedFields.Add("FDS-Created-by-NodeBulder", "[Weight] * [Extended Price] / 100", "Score")

    federationDS.Fill(New DevExpress.Data.IParameter(){})
    Return federationDS
End Function