Interface IConnectionTemplateParameter

Namespace

BiExcellence.OpenBi.Api.ConnectionTemplates

Assembly

BiExcellence.OpenBi.Api.Client.dll

A single parameter of a ConnectionTemplate (or of a DataproviderTypeDto blueprint).

public interface IConnectionTemplateParameter

Properties

ConnectionTemplateId

The id of the connection template the parameter belongs to. Ignored on save.

string? ConnectionTemplateId { get; init; }

Property Value

string

Id

The server-assigned id of the parameter row. Ignored on save - a template's parameters are replaced wholesale and every row gets a new id. Not set in a DataproviderTypeDto blueprint.

string? Id { get; init; }

Property Value

string

IsSupplied

true when the value is supplied by the server rather than by the user logging on. Supplied parameters are only returned to callers holding openbi.connectiontemplate.write.

bool IsSupplied { get; init; }

Property Value

bool

Name

The name the dataprovider type knows the parameter by, e.g. USERNAME or PASSWORD. Unique within a template.

string? Name { get; init; }

Property Value

string

Position

The parameter's position within the template, from 0. Ignored on save - the order of Parameters is the position.

int Position { get; init; }

Property Value

int

Type

One of the ConnectionTemplateParameterType constants.

string? Type { get; init; }

Property Value

string

Value

The stored value - in a DataproviderTypeDto blueprint, the default value. When a template is validated, the placeholders %OPENBI_USERNAME%, %OPENBI_PASSWORD% and %OPENBI_REALM% as the value of USERNAME, PASSWORD and REALM are replaced from the session user.

string? Value { get; init; }

Property Value

string