IAutomationsContextValue

Home > @gooddata/sdk-ui-dashboard > IAutomationsContextValue

IAutomationsContextValue interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Main context shared across all automation dialogs. Only fields actively consumed by migrated leaves are listed here — add fields as each leaf migrates.

Signature:

export interface IAutomationsContextValue 

Properties

Property	Modifiers	Type	Description
allowHourlyRecurrence		boolean	(ALPHA)
attributeFilterConfigs		IDashboardAttributeFilterConfig[]	(ALPHA)
attributeFilterConfigsByTab		Record<string, IDashboardAttributeFilterConfig[]>	(ALPHA)
attributeFilterSelectionTypeMap		Map<string, DashboardAttributeFilterSelectionType | undefined>	(ALPHA)
attributeFilterSelectionTypeMapByTab		Record<string, Map<string, DashboardAttributeFilterSelectionType | undefined>>	(ALPHA)
automationAvailableFilters		FilterContextItem[]	(ALPHA)
automationFiltersByTab		IAutomationFiltersTab[]	(ALPHA)
availableFilters		FilterContextItem[]	(ALPHA)
catalogAttributes		ICatalogAttribute[]	(ALPHA)
catalogDateDatasets		ICatalogDateDataset[]	(ALPHA)
catalogMeasures		ICatalogMeasure[]	(ALPHA)
commonDateFilterId		string | undefined	(ALPHA)
currentUser		IUser	(ALPHA)
dateFilterConfig		IAutomationsDateFilterConfig	(ALPHA)
dateFilterConfigOverridesByTab		Record<string, IDashboardDateFilterConfig | undefined>	(ALPHA)
dateFilterConfigs		IDashboardDateFilterConfigItem[]	(ALPHA)
dateFilterConfigsByTab		Record<string, IDashboardDateFilterConfigItem[]>	(ALPHA)
dateFilterContextConfig		IDashboardDateFilterConfig | undefined	(ALPHA)
defaultSelectedFilters		FilterContextItem[]	(ALPHA)
exportTimezones?		{ isTimezoneFeatureEnabled: boolean; allowUserOverrideInViewMode: boolean; configuredTimezoneId: string | undefined; workspaceTimezone: string | undefined; effectiveTimezone: string | undefined; scheduledExportTimezone: string | undefined; }	(ALPHA) (Optional) Timezone inputs of the scheduled-export "Time zone" section, read from the dashboard store by the connectors layer — the scheduledEmail tree must not touch the store itself.
externalRecipient		string | undefined	(ALPHA)
features		{ canCreateAutomation: boolean; enableAlertOncePerInterval: boolean; enableAnomalyDetectionAlert: boolean; canUseAiAssistant: boolean; canManageWorkspace: boolean; enableSlideshowExports: boolean; enableAutomationEvaluationMode: boolean; }	(ALPHA)
getAttributeFilterDisplayForm		(displayForm: ObjRef) => IAttributeDisplayFormMetadataObject | undefined	(ALPHA)
getCatalogAttributeByRef		(ref: ObjRef) => ICatalogAttribute | ICatalogDateAttribute | undefined	(ALPHA)
hiddenFilters		FilterContextItem[]	(ALPHA)
isExecutionTimestampMode		boolean	(ALPHA)
isSecondaryTitleVisible		boolean	(ALPHA)
isWhiteLabeled		boolean	(ALPHA)
locale		ILocale	(ALPHA)
lockedFilters		FilterContextItem[]	(ALPHA)
maxAutomationsRecipients		number	(ALPHA)
measureValueFilterConfigs		IDashboardMeasureValueFilterConfig[]	(ALPHA)
measureValueFilterConfigsByTab		Record<string, IDashboardMeasureValueFilterConfig[]>	(ALPHA)
parameters		IAutomationsParameters	(ALPHA)
scheduleEmailDialogReturnFocusTo?		string	(ALPHA) (Optional) Element ID to return focus to when the scheduled-email dialog closes. Shared by both the create/edit dialog and the management dialog tree via useScheduleEmailDialogAccessibility.
separators		ISeparators	(ALPHA)
settings?		ISettings	(ALPHA) (Optional)
tabIds		string[]	(ALPHA) Local identifiers of the dashboard's tabs, in layout order; empty when the dashboard has none. Narrowed from selectTabs (ITabState[] | undefined) because every consumer only ever reads localIdentifier, and all of them already coalesce undefined to [].
timezone		string | undefined	(ALPHA) Automation timezone to display and compute schedule ("Starts on", alert crons, next-run): the effective dashboard timezone when one is defined, otherwise the workspace setting. Initial value for new schedule is same as exportTimezones.effectiveTimezone, but then can be never changed for existing schedule. Logic that needs to know where the timezone came from should use IAutomationsContextValue.exportTimezones instead.
weekStart		WeekStart	(ALPHA)
widgetExistsByRef		(ref: ObjRef | undefined) => boolean	(ALPHA) Returns true when a widget with the given ref still exists on the dashboard layout. Bridges identifier↔URI mismatches the same way as selectWidgetByRef. NOTE: do NOT narrow to isWidget() here — this is a pure existence check on the ObjRefMap.
widgetLocalIdToTabIdMap		Record<string, string>	(ALPHA) Maps a widget's localIdentifier to the localIdentifier of the tab that owns it.