ISettings

Home > @gooddata/sdk-model > ISettings

ISettings interface

Settings are obtained from backend and are effectively a collection of feature flags or settings with concrete string or numeric value.

Signature:

export interface ISettings 

Remarks

Settings are stored and configured on the server and typically allow for a more fine-grained tuning of otherwise unified behavior.

Properties

Property	Modifiers	Type	Description
activeCalendars?		IActiveCalendars	(Optional) Active calendars configuration
activeLlmProvider?		ILlmActiveProvider	(Optional) LLM provider id as default for the platform.
ADCatalogGroupsExpanded?		boolean	(Optional) Indicates whether the catalog groups in analytical designer are expanded by default.
aiChatSearchLimit?		number	(Optional) AI Chat search limit
aiRateLimit?		number	(Optional) Ai rate limit in requests per minute.
alertDefault?		IAlertDefault	(Optional) Represents alert default configuration
allowUnsafeFlexConnectEndpoints?		boolean	(Optional) If true, non-TLS endpoints may be used for FlexConnect. Otherwise, only TLS-enabled endpoints may be used.
attachmentSizeLimit?		number | null	(Optional) Attachment size limit in bytes (null for no limit).
currencyFormatOverride?		string | null	(ALPHA) (Optional) Resolved currency format override from metricFormatOverride.formats["CURRENCY"]. This is a convenience property normalized during settings resolution.
dashboardFiltersApplyMode?		DashboardFiltersApplyMode	(ALPHA) (Optional) Represents configuration for Dashboard Filters Apply Mode
dateFilterConfig?		IDateFilterConfig	(ALPHA) (Optional) Date filter configuration.
disableKpiDashboardHeadlineUnderline?		boolean	(Optional) Headline component will not be underlined when it is set up with drilling.
earlyAccessFeatures?		IEarlyAccessFeaturesConfig	(BETA) (Optional) Early access features configuration.
enableAccessibilityMode?		boolean	(Optional) Enable accessibility mode
enableAccessibleChartTooltip?		boolean	(Optional) Enables accessible chart tooltips with improved readability and persistence for disabled users.
enableAIFunctions?		boolean	(Optional) Enable GenAI-powered functionality, such as semantic-search.
enableAIKnowledge?		boolean	(Optional) Enable AI Knowledge feature
enableAiOnData?		boolean	(Optional) Allow sending aggregated data to LLM.
enableAlertAttributes?		boolean	(Optional) Enables attributes in alerts.
enableAlerting?		boolean	(Optional) Enables alerting of the dashboard widgets.
enableAlertingRollout?		boolean	(Optional) Enables alerting rollout of the dashboard widgets.
enableAlertOncePerInterval?		boolean	(Optional) Enable alert once per interval
enableAlertsEvaluationFrequencySetup?		boolean	(Optional) Enable to setup alerts evaluation frequency in dashboard settings.
enableAmplitudeTracker?		boolean	(Optional) Enables tracking events to Amplitude.
enableAnomalyDetectionAlert?		boolean	(Optional) Enable anomaly detection alert
enableAnomalyDetectionVisualization?		boolean	(Optional) Enable anomaly detection in visualization
enableArbitraryFilterAD?		boolean	(Optional) Enable arbitrary filter in Analytical Designer.
enableArbitraryFilterKD?		boolean	(Optional) Enable arbitrary filter in Dashboard app.
enableAthenaDataSource?		boolean	(Optional)
enableAutomationEvaluationMode?		boolean	(Optional) Enable automation evaluation mode.
enableAutomationFilterContext?		boolean	(Optional) Enable automation filter context.
enableAutomationManagement?		boolean	(Optional) Enable automation management in dashboards
enableCatalogTrendingObjects?		boolean	(Optional) Enable trending and recommended object tabs in Analytics Catalog.
enableCertification?		boolean	(Optional) Enable certification indicators in Analytics Catalog.
enableChangeAnalysis?		boolean	(Optional) Enable change analysis
enableComparisonInAlerting?		boolean	(Optional) Enables comparison in alerting.
enableCompositeGrain?		boolean	(Optional) Enable use of composite grain
enableCrateDbDataSource?		boolean	(Optional)
enableCreateUser?		boolean	(Optional) Enable creating users in user management.
enableCustomizedDashboardsWithoutPluginOverlay?		boolean	(Optional) Enable customized dashboards without plugin overlay. When enabled, the plugin overlay will not be displayed on dashboard items.
enableDashboardDescriptionDynamicHeight?		boolean	(Optional) Enable dynamic height of the dashboard section description fields in dashboard edit mode.
enableDashboardFilterGroups?		boolean	(Optional) Enable dashboard filter groups. Filter group are items in a filter bar which groups regular attribute filters into a logical groups. Groups are configured via dashboard metadata new tab property called filterGroupsConfig.
enableDashboardFilterViews?		boolean	(Optional) Enable multiple data sources to be used in a single workspace.
enableDashboardSectionHeadersDateDataSet?		boolean	(ALPHA) (Optional) Enable dashboard-level date dataset configuration for section headers. Allows users to select which date dataset to use for filtering metrics in section header rich text.
enableDashboardShareDialogLink?		boolean	(Optional) Enable dashboard share dialog link
enableDashboardShareLink?		boolean	(Optional) Enable the URL sharing functionality in the dashboard share dialog.
enableDashboardTabularExport?		boolean	(Optional) Enable dashboard tabular export
enableDataSection?		boolean	(Optional)
enableDateFilterIdentifiersRollout?		boolean	(Optional) Enables storing date filter identifiers.
enableDefaultSmtp?		boolean	(Optional) Enable the use of default SMTP in destinations.
enableDescriptions?		boolean	(Optional) Enable usage of insights, widgets, kpis descriptions.
enableDestinationTesting?		boolean	(Optional) Enable the possibility to test destinations (emails, webhooks) in the UI.
enableDrilledTooltip?		boolean	(Optional) Enable drilled tooltip in drill dialog
enableDrillToUrlByDefault?		boolean	(Optional) This setting enables drills into URL in pivot table charts by default on all available attributes. Renders table cells as hyperlinks.
enableEmbedButtonInAD?		boolean	(Optional) Indicates whether the Embed button/dialog is available in AD.
enableEmbedButtonInKD?		boolean	(Optional) Indicates whether the Embed dashboard button is available in KPI dashboards.
enableExecutionCancelling?		boolean	(Optional) Enable execution cancelling.
enableExecutionTimestamp?		boolean	(Optional) Enable using execution timestamp.
enableExportToDocumentStorage?		boolean	(Optional) Enable export to document storage.
enableExternalRecipients?		boolean	(Optional) Enable external recipients options
enableFilterAccessibility?		boolean	(Optional) Enable filter accessibility features including redesigned date filter components.
enableFilterControlInDrillingConfiguration?		boolean	(Optional) Enable filter control in drilling configuration.
enableFiscalCalendars?		boolean	(Optional) Enable fiscal calendars configuration.
enableGenAICatalogQualityChecker?		boolean	(Optional) Enable GenAI catalog quality checker in Analytics Catalog.
enableGenAIChat?		boolean	(Optional) Enable Gen AI Chatbot in UI.
enableGenAIChatRollout?		boolean	(Optional) Enable Gen AI Chatbot rollout in UI.
enableGenAIMemory?		boolean	(Optional) Enable GenAI memory feature
enableGenAIReasoningVisibility?		boolean	(Optional) Enable GenAI reasoning visibility.
enableGeoArea?		boolean	(Optional) Enable geo area labels.
enableGeoBasemapConfig?		boolean	(Optional) Enable basemap selection in geo chart configuration.
enableGeoChartA11yImprovements?		boolean	(Optional) Enables geo accessibility enhancements introduced for map canvas, legend semantics, live announcements, and alternate table view.
enableGeoChartsViewportConfig?		boolean	(Optional) Enables viewport configuration for geo charts (custom viewport + pan/zoom navigation controls).
enableGeoSegmentConflictRecommendation?		boolean	(Optional) Enables analytical designer recommendation for geo charts when locations contain conflicting segment values.
enableHeadlineExport?		boolean	(Optional) Enables manual headline exports on dashboard.
enableHighchartsAccessibility?		boolean	(Optional) Enables Highcharts accessibility features.
enableIgnoreCrossFiltering?		boolean	(Optional) Enables ignore cross-filtering in widgets on dashboard.
enableImmediateAttributeFilterDisplayAsLabelMigration?		boolean	(Optional) Enable immediate attribute filter displayAsLabel migration information propagation right upon the load of the component.
enableImplicitDrillToUrl?		boolean	(Optional) This feature flag enables automatic drill to url setting feature.
enableImprovedAdFilters?		boolean	(Optional) Enable improved attribute filters experience in Analytical Designer.
enableInPlatformNotifications?		boolean	(Optional) Enable in-platform notifications.
enableKDAttributeFilterDatesValidation?		boolean	(Optional) Enable attribute filter values validation by date filters.
enableKDCrossFiltering?		boolean	(Optional) Enable cross filtering in KD
enableKDEmptyDateValuesFilter?		boolean	(Optional) Enables "Empty date values" configuration in KPI Dashboards date filter.
enableKDRespectLegendPosition?		boolean	(Optional) Enable to respect chart legend position in KD.
enableKDRichText?		boolean	(Optional) Enables rich text widgets on dashboards.
enableKDVisualizationSwitcher?		boolean	(Optional) Enables visualization switcher widgets on dashboards.
enableLineChartTrendThreshold?		boolean	(Optional) Enable a configurable trend threshold in line chart visualization.
enableLlmEndpointReplacement?		boolean	(Optional) Enables the replacement of LLM endpoints.
enableMariaDbDataSource?		boolean	(Optional)
enableMatchFilterAD?		boolean	(Optional) Enable match filter in Analytical Designer.
enableMatchFilterKD?		boolean	(Optional) Enable match filter in Dashboard app.
enableMetricFormatOverrides?		boolean	(Optional) Enables UI and API support for metric type selection and metric format overrides management.
enableMongoDbDataSource?		boolean	(Optional)
enableMotherDuckDataSource?		boolean	(Optional)
enableMultipleDataSourcesInWorkspace?		boolean	(Optional) Enable multiple data sources to be used in a single workspace.
enableMultipleDateFilters?		boolean	(Optional) Enable multiple date filters.
enableMultipleMvfConditions?		boolean	(Optional) Enable multiple conditions in measure value filters (MVF).
enableMySqlDataSource?		boolean	(Optional)
enableNewGeoPushpin?		boolean	(Optional) Enable new geo pushpin chart
enableNewPdfTabularExport?		boolean	(Optional) Enable new PDF tabular export option for insights.
enableNewPivotTable?		boolean	(Optional) Enable new pivot table
enableNewScheduledExport?		boolean	(Optional) Enable new scheduled export
enableNewUserCreationFlow?		boolean	(Optional) Enable the use of new user creation flow.
enableNotificationChannelIdentifiers?		boolean	(Optional) Enable notification channel identifiers
enableNullJoins?		boolean	(Optional) Enable NULL-aware joins used for FULL OUTER JOIN conditions.
enableNumberSeparators?		boolean	(Optional) Enable number separators configuration in home-ui (both organization and workspace level).
enableOracleDataSource?		boolean	(Optional)
enableOrchestratedTabularExports?		boolean	(Optional) Enable orchestrated tabular exports
enablePivotTableIncreaseBucketSize?		boolean	(Optional) Enable new max bucket size items limit for Pivot Table
enablePivotTablePagination?		boolean	(Optional) Enable pagination for the pivot table.
enablePreAggregationDatasets?		boolean	(Optional) Enable pre-aggregation datasets support in LDM Modeler.
enableRankingWithMvf?		boolean	(Optional) Enable ranking filter to be used together with measure value filters (MVF).
enableRawExports?		boolean	(Optional) Enable insights export of raw data when limit is reached.
enableRichTextDescriptions?		boolean	(Optional) Enables rich text in descriptions.
enableRichTextDynamicReferences?		boolean	(Optional) Enable rich text dynamic references.
enableRichTextWidgetFilterConfiguration?		boolean	(ALPHA) (Optional) Enable rich text widget filter configuration. Allows users to configure date and attribute filter settings for rich text widgets.
enableScatterPlotClustering?		boolean	(Optional) Enable clustering in scatter plot.
enableScatterPlotSegmentation?		boolean	(Optional) Enables segmentation in scatter plot.
enableScheduling?		boolean	(Optional) Enables scheduling of the dashboard pdf export.
enableSeamlessIdpSwitch?		boolean	(Optional) Enable custom Identity Provider
enableSemanticSearch?		boolean	(Optional) Enable Semantic Search in the UI.
enableSemanticSearchRollout?		boolean	(Optional) Enable Semantic Search rollout in the UI.
enableShellApplication?		boolean	(Optional) Enable shell application.
enableSingleStoreDataSource?		boolean	(Optional)
enableSlidesExport?		boolean	(Optional) Enable slideshow exports settings from server
enableSlideshowExports?		boolean	(Optional) Enable slideshow exports using the new export render mode in KD.
enableSmtp?		boolean	(Optional) Enables smtp settings.
enableSnapshotExport?		boolean	(Optional) Enable snapshot export
enableSnapshotExportAccessibility?		boolean	(Optional) Enable accessibility enhancements for snapshot export.
enableSnowflakeKeyPairAuthentication?		boolean	(Optional)
enableStarrocksDataSource?		boolean	(Optional)
enableToDateFilters?		boolean	(Optional) Enable "to date" filters also known as "bounded" filters (e.g. YTD, QTD, MTD, WTD)
enableUserManagement?		boolean	(Optional) Enable user management page in Home UI.
enableVisualizationFilteringByTags?		boolean	(Optional) Enable filtering of visualizations by tags provided via URL.
enableVisualizationFineTuning?		boolean	(Optional) Enable fine-tuning options for visualization in AD configuration panel.
enableWaterfallChart?		boolean	(Optional) Indicates whether the Waterfall Chart is available in AD.
enableWidgetExportPdf?		boolean	(Optional) Enable widget export to PDF.
enableWidgetExportPngImage?		boolean	(Optional) Enable widget export to PNG image.
enableWidgetIdentifiersRollout?		boolean	(Optional) Enables storing widget identifiers.
enableWorkspaceSettingsAppHeaderMenuItem?		boolean	(Optional) Enables workspace settings link in account menu of the user in every app header.
exportResultPollingTimeoutSeconds?		number	(Optional) Override the default timeout for polling for the export results.
fiscalYear?		IFiscalYear	(Optional) Fiscal year calendar configuration
formatLocale?		string	(Optional) Locale code to use for date formatting.
llmEndpoint?		ILlmEndpoint	(Optional) LLM endpoint id as default for the platform.
maxZoomLevel?		number | null	(Optional) Maximum zoom level applied to geo visualizations.
metadataLocale?		string	(Optional) Locale code to use for metadata.
metadataTimeZone?		string	(Optional) IANA identifier of time zone in which the platform metadata are stored.
metricFormatOverride?		IMetricFormatOverrideSetting	(ALPHA) (Optional) Metric format override configuration.
openAiConfig?		IOpenAiConfig	(ALPHA) (Optional) Represents configuration for OpenAI integration
platformEdition?		PlatformEdition	(Optional) Indicates current platform edition.
productionFeatures?		IProductionFeaturesConfig	(ALPHA) (Optional) Enable production features
registeredPluggableApplications?		string	(Optional) Registered pluggable applications
responsiveUiDateFormat?		string	(Optional) Indicates the format in which the dates will be displayed
restrictBaseUi?		boolean	(Optional) Restrict access to Base UI applications.
showHiddenCatalogItems?		boolean	(Optional) Indicates whether unavailable data items are visible in the settings API only available on Tiger/Panther
timezone?		string	(Optional) Timezone
weekStart?		WeekStart	(Optional) Week start day
whiteLabeling?		IWhiteLabeling	(Optional) Represents whiteLabeling configuration