Interface IServerSettings

Namespace

BiExcellence.OpenBi.Api.SystemInfo

Assembly

BiExcellence.OpenBi.Api.Client.dll

The server's raw configuration, from GET /system/configuration. Only reachable on the dedicated configuration port, in addition to the normal permission check.

public interface IServerSettings

Properties

Configuration

The server's effective configuration from all of its configuration sources, flattened to Section:Key paths. Read-only - it is not written back. Secrets - names containing PASSWORD other than at the start - read as SecretPlaceholder.

Dictionary<string, string?>? Configuration { get; init; }

Property Value

Dictionary<string, string>

Parameters

The settings from Configuration.xml, standard and custom ones alike. This is what SetConfigurationAsync(IOpenBiApiClient, ConfigurationSetting[], CancellationToken) takes back.

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

Property Value

List<ConfigurationSetting>

Sources

Where each value in Configuration comes from, by the same keys: shared (the database, see SharedConfigurationSetting), local (Configuration.xml), environment, commandLine or host (set by the server itself). Keys without a value of their own are left out; null from a server that predates it.

Dictionary<string, string>? Sources { get; init; }

Property Value

Dictionary<string, string>