IPermanentSettings
Setting properties are used to customize platform behavior for end users. These are permanent setting options that are intended to remain, unlike feature-flag-based settings.
On the Panther/Tiger platform, each setting is backed by a metadata object with a unique setting type registered in the backend.
export interface IPermanentSettings
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) Active calendars configuration | |||
(Optional) LLM provider id as default for the platform. | |||
boolean | (Optional) Indicates whether the catalog groups in analytical designer are expanded by default. | ||
(Optional) AI rate limit configuration: max interactions per rolling time window. | |||
(Optional) Represents alert default configuration | |||
boolean | (Optional) If true, non-TLS endpoints may be used for FlexConnect. Otherwise, only TLS-enabled endpoints may be used. | ||
number | null | (Optional) Attachment size limit in bytes (null for no limit). | ||
string | null | (ALPHA) (Optional) Resolved currency format override from metricFormatOverride.formats[“CURRENCY”]. This is a convenience property normalized during settings resolution. | ||
(ALPHA) (Optional) Represents configuration for Dashboard Filters Apply Mode | |||
string | (Optional) Locale code to use for data values. | ||
(ALPHA) (Optional) Date filter configuration. | |||
(BETA) (Optional) Default export template applied to slide exports when none is explicitly requested. | |||
(ALPHA) (Optional) Who can view a newly created metric. Applies only with | |||
(ALPHA) (Optional) Who can view a newly created visualization. Applies only with | |||
boolean | (Optional) Headline component will not be underlined when it is set up with drilling. | ||
(BETA) (Optional) Early access features configuration. | |||
boolean | (Optional) Enable automation evaluation mode. | ||
string | (Optional) Default delimiter to use for CSV exports when not overridden by request. | ||
number | (Optional) Override the default timeout for polling for the export results. | ||
(Optional) Fiscal year calendar configuration | |||
string | (Optional) Locale code to use for date formatting. | ||
(Optional) LLM endpoint id as default for the platform. | |||
number | null | (Optional) Maximum zoom level applied to geo visualizations. | ||
string | (Optional) Locale code to use for metadata. | ||
string | (Optional) IANA identifier of time zone in which the platform metadata are stored. | ||
(ALPHA) (Optional) Metric format override configuration. | |||
(ALPHA) (Optional) Represents configuration for OpenAI integration | |||
(Optional) Indicates current platform edition. | |||
string | (Optional) Indicates the format in which the dates will be displayed | ||
boolean | (Optional) Restrict access to Base UI applications. | ||
boolean | (Optional) Indicates whether unavailable data items are visible in the settings API only available on Tiger/Panther | ||
string | (Optional) Timezone | ||
(Optional) Week start day | |||
(Optional) Represents whiteLabeling configuration |
Property details
IPermanentSettings.activeCalendarsproperty
Active calendars configuration
activeCalendars?: IActiveCalendars;
IPermanentSettings.activeLlmProviderproperty
LLM provider id as default for the platform.
activeLlmProvider?: ILlmActiveProvider;
IPermanentSettings.ADCatalogGroupsExpandedproperty
Indicates whether the catalog groups in analytical designer are expanded by default.
ADCatalogGroupsExpanded?: boolean;
IPermanentSettings.aiRateLimitproperty
AI rate limit configuration: max interactions per rolling time window.
aiRateLimit?: IAiRateLimit;
IPermanentSettings.alertDefaultproperty
Represents alert default configuration
alertDefault?: IAlertDefault;
IPermanentSettings.allowUnsafeFlexConnectEndpointsproperty
If true, non-TLS endpoints may be used for FlexConnect. Otherwise, only TLS-enabled endpoints may be used.
allowUnsafeFlexConnectEndpoints?: boolean;
IPermanentSettings.attachmentSizeLimitproperty
Attachment size limit in bytes (null for no limit).
attachmentSizeLimit?: number | null;
IPermanentSettings.currencyFormatOverridepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Resolved currency format override from metricFormatOverride.formats[“CURRENCY”]. This is a convenience property normalized during settings resolution.
currencyFormatOverride?: string | null;
IPermanentSettings.dashboardFiltersApplyModepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Represents configuration for Dashboard Filters Apply Mode
dashboardFiltersApplyMode?: DashboardFiltersApplyMode;
IPermanentSettings.dataLocaleproperty
Locale code to use for data values.
dataLocale?: string;
IPermanentSettings.dateFilterConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Date filter configuration.
dateFilterConfig?: IDateFilterConfig;
IPermanentSettings.defaultExportTemplatepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Default export template applied to slide exports when none is explicitly requested.
defaultExportTemplate?: IDefaultExportTemplate;
IPermanentSettings.defaultMetricVisibilitypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Who can view a newly created metric. Applies only with enableMetricPermissions. The backend treats an unset value as RESTRICTED.
defaultMetricVisibility?: ObjectVisibility;
IPermanentSettings.defaultVisualizationVisibilitypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Who can view a newly created visualization. Applies only with enableVisualizationPermissions. The backend treats an unset value as RESTRICTED.
defaultVisualizationVisibility?: ObjectVisibility;
IPermanentSettings.disableKpiDashboardHeadlineUnderlineproperty
Headline component will not be underlined when it is set up with drilling.
disableKpiDashboardHeadlineUnderline?: boolean;
IPermanentSettings.earlyAccessFeaturespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Early access features configuration.
earlyAccessFeatures?: IEarlyAccessFeaturesConfig;
IPermanentSettings.enableAutomationEvaluationModeproperty
Enable automation evaluation mode.
enableAutomationEvaluationMode?: boolean;
IPermanentSettings.exportCsvCustomDelimiterproperty
Default delimiter to use for CSV exports when not overridden by request.
exportCsvCustomDelimiter?: string;
IPermanentSettings.exportResultPollingTimeoutSecondsproperty
Override the default timeout for polling for the export results.
exportResultPollingTimeoutSeconds?: number;
IPermanentSettings.fiscalYearproperty
Fiscal year calendar configuration
fiscalYear?: IFiscalYear;
IPermanentSettings.formatLocaleproperty
Locale code to use for date formatting.
formatLocale?: string;
IPermanentSettings.llmEndpointproperty
LLM endpoint id as default for the platform.
llmEndpoint?: ILlmEndpoint;
IPermanentSettings.maxZoomLevelproperty
Maximum zoom level applied to geo visualizations.
maxZoomLevel?: number | null;
Remarks
Null or undefined means that zoom is unrestricted and default chart settings will be applied.
IPermanentSettings.metadataLocaleproperty
Locale code to use for metadata.
metadataLocale?: string;
IPermanentSettings.metadataTimeZoneproperty
IANA identifier of time zone in which the platform metadata are stored.
metadataTimeZone?: string;
IPermanentSettings.metricFormatOverridepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Metric format override configuration.
metricFormatOverride?: IMetricFormatOverrideSetting;
IPermanentSettings.openAiConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Represents configuration for OpenAI integration
openAiConfig?: IOpenAiConfig;
IPermanentSettings.platformEditionproperty
Indicates current platform edition.
platformEdition?: PlatformEdition;
IPermanentSettings.responsiveUiDateFormatproperty
Indicates the format in which the dates will be displayed
responsiveUiDateFormat?: string;
IPermanentSettings.restrictBaseUiproperty
Restrict access to Base UI applications.
restrictBaseUi?: boolean;
IPermanentSettings.showHiddenCatalogItemsproperty
Indicates whether unavailable data items are visible in the settings API only available on Tiger/Panther
showHiddenCatalogItems?: boolean;
IPermanentSettings.timezoneproperty
Timezone
timezone?: string;
IPermanentSettings.weekStartproperty
Week start day
weekStart?: WeekStart;
IPermanentSettings.whiteLabelingproperty
Represents whiteLabeling configuration
whiteLabeling?: IWhiteLabeling;