BiExcellence.OpenBi.Api.DataProvider 1.0.3-ci.18192

BiExcellence.OpenBi.Api.DataProvider

Includes APIs related to get / create / delete connection templates and open / execute dataproviders in open bi Respository Servers.

Usage

Connection Templates

using BiExcellence.OpenBi.Api.Commands.ConnectionTemplates;

var dataProviderTypes = await session.GetDataProviderTypesAsync(cancellationToken);

var connectionTemplates = await session.GetConnectionTemplatesAsync(cancellationToken);

var newConnectionTemplate = new ConnectionTemplate(dataProviderTypes[0]);
newConnectionTemplate.Parameters[0].Value = "VALUE";
// or manually
var newConnectionTemplate = new ConnectionTemplate { Name = "New Name", Description = "New Description", DataProviderType = DataProviderTypes.CORE };
newConnectionTemplate.Parameters.Add(new ConnectionTemplateParameter("NAME", "VALUE"));

await session.CreateConnectionTemplateAsync(newConnectionTemplate, cancellationToken);

var connection = await session.ValidateConnectionAsync(newConnectionTemplate, cancellationToken);

await session.DeleteConnectionTemplateAsync(newConnectionTemplate, cancellationToken);

Data Providers

using BiExcellence.OpenBi.Api.Commands;
using BiExcellence.OpenBi.Api.Commands.DataProviders;

var dataProviderNodes = await connection.GetDataProvidersAsync(cancellationToken: cancellationToken);

var usedConnections = await dataProviderNodes[0].OpenAsync(newConnectionTemplate, cancellationToken);

await using (var dataProviderView = await usedConnections.GetDataProviderViewAsync(cancellationToken))
{
    dataProviderView.Executing += Executing;
    dataProviderView.Executed += Executed;

    var dataProviderDefinition = await dataProviderView.GetDataProviderDefinitionAsync(cancellationToken);

    var f4values = await dataProviderView.GetF4ValuesAsync(dataProviderView.DataProviderDefinition.Dimensions["COUNTRY"], cancellationToken);
    var f4values = await dataProviderView.GetF4ValuesAsync(dataProviderView.DataProviderDefinition.Variables["DATE"], cancellationToken);

    dataProviderView.DataProviderDefinition.Dimensions["COUNTRY"].Axis = DimensionAxis.Rows;
    dataProviderView.DataProviderDefinition.KeyFigures["COUNT"].IsHidden = true;
    dataProviderView.DataProviderDefinition.Variables["DATE"].Filters.Add(new Filter("2021-01-01", FilterOperator.Equal));

    var execute = await dataProviderView.ExecuteAsync(cancellationToken);

    var grid = await dataProviderView.GetGridDataAsync(cancellationToken: cancellationToken);
    var chart = await dataProviderView.GetChartDataAsync(cancellationToken: cancellationToken);
}

void Executing(object sender, EventArgs e) => Console.WriteLine("Before Execute");
void Executed(object sender, GridDefinitionEventArgs e) => Console.WriteLine("After Execute");