Interface IConnectionTemplate

Namespace

BiExcellence.OpenBi.Api.ConnectionTemplates

Assembly

BiExcellence.OpenBi.Api.Client.dll

A connection template: the named, reusable configuration a data provider connection is opened from.

public interface IConnectionTemplate

Properties

CustomAttributes

The values of the custom table attributes defined for connection templates (table CONNECTION_TEMPLATE, see GetTableAttributesAsync), by attribute name.

Dictionary<string, JsonElement>? CustomAttributes { get; init; }

Property Value

Dictionary<string, JsonElement>

DataproviderType

The data provider this template connects to, e.g. SAP_BW or MSSQL - see DataproviderTypeDto.

string? DataproviderType { get; init; }

Property Value

string

Description

A free-text description of the template.

string? Description { get; init; }

Property Value

string

Id

The id of the template - server-generated unless the creator chose one. A built-in template has a fixed id; a SAP_BW_DB twin has the id of its SAP BW template plus _SAP_BW_DB.

string? Id { get; init; }

Property Value

string

IsBuiltIn

true for the server-provided templates (OPENBI, MASTER, ENTITY, CORE) and for the synthesized SAP_BW_DB twin of a SAP BW template. These have no stored row and cannot be created, updated or deleted.

bool IsBuiltIn { get; init; }

Property Value

bool

IsHidden

Whether the template should be hidden in connection pickers.

bool IsHidden { get; init; }

Property Value

bool

Name

The display name of the template, for connection pickers.

string? Name { get; init; }

Property Value

string

Parameters

The template's parameters, ordered by Position.

List<ConnectionTemplateParameter>? Parameters { get; init; }

Property Value

List<ConnectionTemplateParameter>