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
ADCatalogGroupsExpanded?		boolean	(Optional) Indicates whether the catalog groups in analytical designer are expanded by default.
ADMeasureValueFilterNullAsZeroOption?		string	(Optional) Indicates whether "Treat null as zero" option should be displayed in measure value filter configuration and its default state"
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).
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.
enableAccessibleChartTooltip?		boolean	(Optional) Enables accessible chart tooltips with improved readability and persistence for disabled users.
enableAdDescriptionEdit?		boolean	(Optional) Enable editing of insight description in AD.
enableADMultipleDateFilters?		boolean	(Optional) Enable multiple date filters in AD.
enableAIFunctions?		boolean	(Optional) Enable GenAI-powered functionality, such as semantic-search.
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.
enableAlertsEvaluationFrequencySetup?		boolean	(Optional) Enable to setup alerts evaluation frequency in dashboard settings.
enableAlternativeDisplayFormSelection?		boolean	(Optional) Indicates whether alternative display form can be selected for attribute and multiple instances of the same attributes can be put into buckets
enableAmplitudeTracker?		boolean	(Optional) Enables tracking events to Amplitude.
enableAnalyticalDashboardPermissions?		boolean	(Optional) Enable usage of Dashboard permissions
enableAnalyticalDashboards?		boolean	(Optional)
enableApproxCount?		boolean	(Optional) Indicates whether the approximate variant of count is available in AD.
enableAttributeFilterValuesValidation?		boolean	(Optional) Enable attribute filter values validation by metric, attribute, fact. The configuration of filter values validation is merged with parent filters UI.
enableAttributeFilterVirtualised?		boolean	(Optional) Enable usage of new dropdown list replacing fixed-data-table
enableAutomationEvaluationMode?		boolean	(Optional) Enable automation evaluation mode.
enableAutomationFilterContext?		boolean	(Optional) Enable automation filter context.
enableAutomationManagement?		boolean	(Optional) Enable automation management in dashboards
enableAxisLabelFormat?		boolean	(Optional) Enable axis label formatting
enableAxisNameConfiguration?		boolean	(Optional) Allows configuration of axis name position and visibility for Pluggable Visualizations.
enableAxisNameViewByTwoAttributes?		boolean	(Optional) Enable axis name for the column, bar and bullet charts with view by two attributes.
enableCentralizedAutomationManagement?		boolean	(Optional) Enable centralized automation management in home-ui
enableChartAccessibilityFeatures?		boolean	(Optional) Enables additional chart accessibility features configurable in AD.
enableChartsSorting?		boolean	(Optional) Enable charts sorting customization
enableClickableAttributeURL?		boolean	(Optional) Enable implicit drillToAttributeURL
enableColumnHeadersPosition?		boolean	(Optional) Enable moving column attribute headers to the left.
enableCompanyLogoInEmbeddedUI?		boolean	(Optional) Indicates whether the company logo should be visible in the embedded dashboard.
enableComparisonInAlerting?		boolean	(Optional) Enables comparison in alerting.
enableCompositeGrain?		boolean	(Optional) Enable use of composite grain
enableCreateUser?		boolean	(Optional) Enable creating users in user management.
enableCsvUploader?		boolean	(Optional)
enableCustomColorPicker?		boolean	(Optional) Indicates whether color picker config panel should allow users to select custom RGB colors.
enableDashboardDescriptionDynamicHeight?		boolean	(Optional) Enable dynamic height of the dashboard section description fields in dashboard edit mode.
enableDashboardFiltersApplyModes?		boolean	(Optional) Enable config for a single global "Apply" button on the dashboard, replacing individual apply buttons next to each filter.
enableDashboardFilterViews?		boolean	(Optional) Enable multiple data sources to be used in a single workspace.
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
enableDataSampling?		boolean	(Optional) Indicates whether backend supports data sampling.
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.
enableDrilledInsightExport?		boolean	(Optional) Indicates whether the drilled insight can be exported.
enableDrilledTooltip?		boolean	(Optional) Enable drilled tooltip in drill dialog
enableDuplicatedLabelValuesInAttributeFilter?		boolean	(Optional) Enable listing of the non-unique (duplicated) secondary label values in attribute filter.
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.
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
enableHeadlineExport?		boolean	(Optional) Enables manual headline exports on dashboard.
enableHidingOfWidgetTitle?		boolean	(Optional) Enable hiding of widget title
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.
enableInPlatformNotifications?		boolean	(Optional) Enable in-platform notifications.
enableInsightExportScheduling?		boolean	(Optional) Indicates whether the new UI for scheduled widget exports is enabled.
enableInvalidValuesInAttributeFilter?		boolean	(Optional) Enable possibility to set non-existing value into attribute filter in AD and KD via postMessage.
enableKDAttributeFilterDatesValidation?		boolean	(Optional) Enable attribute filter values validation by date filters.
enableKDCrossFiltering?		boolean	(Optional) Enable cross filtering in KD
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.
enableKDZooming?		boolean	(Optional) Indicates whether the user can zoom on the insights in KPI dashboards that have this feature enabled.
enableKPIDashboardDrillFromAttribute?		boolean	(Optional) Enable drill from attributes
enableKPIDashboardDrillToDashboard?		boolean	(Optional) Indicates whether the drill to dashboard is enabled.
enableKPIDashboardDrillToInsight?		boolean	(Optional) Indicates whether the drill to insight is enabled.
enableKPIDashboardDrillToURL?		boolean	(Optional) Indicates whether the drill to url is enabled.
enableKPIDashboardImplicitDrillDown?		boolean	(Optional) Enable implicit drill down
enableKPIDashboardSaveAsNew?		boolean	(Optional) Indicates whether the user can save and existing dashboard in KPI dashboards as new.
enableKPIDashboardSchedule?		boolean	(Optional) Indicates whether dashboard scheduled mails are enabled.
enableKPIDashboardScheduleRecipients?		boolean	(Optional) Indicates whether the user can select recipients of scheduled e-mails. If not, scheduled mail can only be sent to a logged in user.
enableLineChartTrendThreshold?		boolean	(Optional) Enable a configurable trend threshold in line chart visualization.
enableMariaDbDataSource?		boolean	(Optional)
enableMotherDuckDataSource?		boolean	(Optional)
enableMultipleCSVs?		boolean	(Optional) Enable upload of multiple CSVs to data source and multiple CSV data sources.
enableMultipleDataSourcesInWorkspace?		boolean	(Optional) Enable multiple data sources to be used in a single workspace.
enableMultipleDateFilters?		boolean	(Optional) Enable multiple date filters.
enableMultipleDates?		boolean	(Optional) Indicates whether multiple dates can be put into buckets
enableMySqlDataSource?		boolean	(Optional)
enableNewNavigationForResponsiveUi?		boolean	(Optional)
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
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
enablePivotTableTransposition?		boolean	(Optional) Enable table transposition (metrics in rows)
enablePixelPerfectExperience?		boolean	(Optional)
enablePreAggregationDatasets?		boolean	(Optional) Enable pre-aggregation datasets support in LDM Modeler.
enableRawExports?		boolean	(Optional) Enable insights export of raw data when limit is reached.
enableRenamingMeasureToMetric?		boolean	(Optional) Enable renaming measure to metric
enableRenamingProjectToWorkspace?		boolean	(Optional)
enableReversedStacking?		boolean	(Optional) Enable reverse the order of stacked items in bar chart.
enableRichTextDescriptions?		boolean	(Optional) Enables rich text in descriptions.
enableRichTextDynamicReferences?		boolean	(Optional) Enable rich text dynamic references.
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.
enableSeparateTotalLabels?		boolean	(Optional) Enable visibility control for total labels
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.
enableSnapshotExportAccessibility?		boolean	(Optional) Enable accessibility enhancements for snapshot export.
enableSnowflakeKeyPairAuthentication?		boolean	(Optional)
enableToDateFilters?		boolean	(Optional) Enable "to date" filters also known as "bounded" filters (e.g. YTD, QTD, MTD, WTD)
enableUnavailableItemsVisible?		boolean	(Optional) Indicates whether unavailable data items are visible
enableUserManagement?		boolean	(Optional) Enable user management page in Home UI.
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.
formatLocale?		string	(Optional) Locale code to use for date formatting.
hidePixelPerfectExperience?		boolean	(Optional)
llmEndpoint?		ILlmEndpoint	(Optional) LLM endpoint id as default for the platform.
metadataLocale?		string	(Optional) Locale code to use for metadata.
metadataTimeZone?		string	(Optional) IANA identifier of time zone in which the platform metadata are stored.
openAiConfig?		IOpenAiConfig	(ALPHA) (Optional) Represents configuration for OpenAI integration
platformEdition?		PlatformEdition	(Optional) Indicates current platform edition.
productionFeatures?		IProductionFeaturesConfig	(ALPHA) (Optional) Enable production features
responsiveUiDateFormat?		string	(Optional) Indicates the format in which the dates will be displayed
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