IPermanentSettings

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. See API maturity.

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. See API maturity.

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. See API maturity.

Date filter configuration.

dateFilterConfig?: IDateFilterConfig;

IPermanentSettings.defaultExportTemplatepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

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. See API maturity.

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. See API maturity.

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. See API maturity.

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.grantManageVisualizationsWithAnalyzepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

When true, granting ANALYZE on the workspace also grants the MANAGE_VISUALIZATIONS workspace permission, and revoking ANALYZE revokes it. Changing the setting leaves stored grants as they are.

grantManageVisualizationsWithAnalyze?: boolean;

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. See API maturity.

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. See API maturity.

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;