PivotGridControl.OlapConnectionString Property

Gets or sets a connection string to a cube in an MS Analysis Services database.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.PivotGrid, DevExpress.Wpf.PivotGrid

Declaration

C#

public string OlapConnectionString { get; set; }

VB.NET

Public Property OlapConnectionString As String

Property Value

Type	Description
String	A String that specifies a connection string to a cube in an MS Analysis Services database.

Remarks

To retrieve data from an OLAP cube asynchronously, use the PivotGridControl.SetOlapConnectionStringAsync method to specify a connection string.

A sample connection string is shown below:

OlapConnectionString=”Provider=msolap;Data Source=localhost;Initial Catalog=Adventure Works DW;Cube Name=Adventure Works;Query Timeout=100;”

The connection string has the following parameters:

• Provider - Identifies a data provider to be used. The “msolap” string identifies the latest version of Microsoft SQL Server Analysis Services (SSAS);

  Important

  Note that the Provider parameter is in effect only for the OLE DB provider for Analysis Services specified using the PivotGridControl.OlapDataProvider property.

• Data Source - Specifies the name of a server that runs an instance of SSAS;
• Initial Catalog - Specifies a data catalog that contains cubes;
• Cube Name - Specifies the name of a cube that provides OLAP data;
• Query Timeout (optional) - The maximum amount of time, in seconds, to wait for a query to SSAS to complete. If the parameter is set to 0, each query can last indefinitly.

Example

The following example demonstrates how to bind a PivotGridControl to an MS OLAP cube.

For this, it is required to set the PivotGridControl.OlapConnectionString property value, and add the necessary fields to the PivotGridControl.Fields collection.

View Example

MainWindow.xaml

<Window xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid" 
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        x:Class="HowToBindOLAP.MainWindow"
        Title="MainWindow" Loaded="Window_Loaded"
        Height="350" Width="525">
    <Grid>
        <dxpg:PivotGridControl HorizontalAlignment="Left" VerticalAlignment="Top" 
                               Name="pivotGridControl1" />
    </Grid>
</Window>

MainWindow.xaml.vb

Imports System.Windows
Imports DevExpress.Xpf.PivotGrid

Namespace HowToBindOLAP
    Partial Public Class MainWindow
        Inherits Window

        Public Sub New()
            InitializeComponent()
        End Sub
        Private Sub Window_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
            pivotGridControl1.OlapConnectionString = "Provider=msolap;" &
                "Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;" &
                "Initial Catalog=Adventure Works DW Standard Edition;" &
                "Cube Name=Adventure Works;"
            pivotGridControl1.BeginUpdate()

            ' Create fields.
            Dim fieldMeasuresInternetSalesAmount As New  _
                PivotGridField("[Measures].[Internet Sales Amount]", FieldArea.DataArea)
            fieldMeasuresInternetSalesAmount.Caption = "Internet Sales Amount"

            Dim fieldCustomerCountryCountry As New  _
                PivotGridField("[Customer].[Country].[Country]", FieldArea.RowArea)
            fieldCustomerCountryCountry.Caption = "Country"

            Dim fieldDateFiscalYearFiscalYear As New  _
                PivotGridField("[Date].[Fiscal Year].[Fiscal Year]", FieldArea.ColumnArea)
            fieldDateFiscalYearFiscalYear.Caption = "Fiscal Year"

            ' Add fields to the PivotGridControl
            pivotGridControl1.Fields.AddRange(fieldMeasuresInternetSalesAmount, _
                                        fieldCustomerCountryCountry, fieldDateFiscalYearFiscalYear)
            pivotGridControl1.EndUpdate()
        End Sub
    End Class
End Namespace

MainWindow.xaml.cs

using System.Windows;
using DevExpress.Xpf.PivotGrid;

namespace HowToBindOLAP {
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
        }
        private void Window_Loaded(object sender, RoutedEventArgs e) {
            pivotGridControl1.OlapConnectionString = "Provider=msolap;" +
                "Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;" + 
                "Initial Catalog=Adventure Works DW Standard Edition;" +
                "Cube Name=Adventure Works;";
            pivotGridControl1.BeginUpdate();

            // Create fields.
            PivotGridField fieldMeasuresInternetSalesAmount = 
                new PivotGridField("[Measures].[Internet Sales Amount]", FieldArea.DataArea);
            fieldMeasuresInternetSalesAmount.Caption = "Internet Sales Amount";

            PivotGridField fieldCustomerCountryCountry = 
                new PivotGridField("[Customer].[Country].[Country]", FieldArea.RowArea);
            fieldCustomerCountryCountry.Caption = "Country";

            PivotGridField fieldDateFiscalYearFiscalYear = 
                new PivotGridField("[Date].[Fiscal Year].[Fiscal Year]", FieldArea.ColumnArea);
            fieldDateFiscalYearFiscalYear.Caption = "Fiscal Year";

            // Add fields to the PivotGridControl
            pivotGridControl1.Fields.AddRange(fieldMeasuresInternetSalesAmount, 
                fieldCustomerCountryCountry, fieldDateFiscalYearFiscalYear);

            pivotGridControl1.EndUpdate();
        }
    }
}