Skip to content
You're viewing docs for an older version. Go to the latest version (11.64) →
Request a demo
On this page
interface Beta Source: AutomationsContext.ts ↗

IAutomationsContextValue

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

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

export interface IAutomationsContextValue

Properties

Property

Modifiers

Type

Description

allowHourlyRecurrence

boolean

(BETA) Whether the workspace’s minimum-recurrence entitlement permits hourly schedules; derived from selectEntitlementMinimumRecurrenceMinutes.

attributeFilterConfigs

IDashboardAttributeFilterConfig[]

(BETA) Dashboard-level attribute filter config overrides for the active tab; from selectAttributeFilterConfigsOverrides.

attributeFilterConfigsByTab

Record<string, IDashboardAttributeFilterConfig[]>

(BETA) Same as IAutomationsContextValue.attributeFilterConfigs, keyed by tab identifier; from selectAttributeFilterConfigsOverridesByTab.

attributeFilterSelectionTypeMap

Map<string, DashboardAttributeFilterSelectionType | undefined>

(BETA) Attribute filter selection type (single/multi) by local identifier for the active tab; from selectAttributeFilterConfigsSelectionTypeMap.

attributeFilterSelectionTypeMapByTab

Record<string, Map<string, DashboardAttributeFilterSelectionType | undefined>>

(BETA) Same as IAutomationsContextValue.attributeFilterSelectionTypeMap, keyed by tab identifier; from selectAttributeFilterConfigsSelectionTypeMapByTab.

automationAvailableFilters

FilterContextItem[]

(BETA) Dashboard filters available to an automation — hidden filters removed, common date filter included; from selectAutomationAvailableDashboardFilters.

automationFiltersByTab

IAutomationFiltersTab[]

(BETA) Automation-available filters structured per dashboard tab, for whole-dashboard automations on a tabbed dashboard; from selectAutomationFiltersByTab.

availableFilters

FilterContextItem[]

(BETA) Dashboard’s applied filters with cross-filtering filters removed; from selectAllDashboardFiltersWithoutCrossFiltering.

catalogAttributes

ICatalogAttribute[]

(BETA) Workspace attribute catalog, including computed attributes; from selectCatalogAttributesWithComputed.

catalogDateDatasets

ICatalogDateDataset[]

(BETA) Workspace date dataset catalog; from selectCatalogDateDatasets.

catalogMeasures

ICatalogMeasure[]

(BETA) Workspace measure catalog; from selectCatalogMeasures.

commonDateFilterId

string | undefined

(BETA) Local identifier of the dashboard’s common date filter, when the automation-available filters include one; from selectAutomationCommonDateFilterId.

currentUser

IUser

(BETA) The logged-in user; from selectCurrentUser.

dateFilterConfig

IAutomationsDateFilterConfig

(BETA) Date filter granularities and presets for automation date filter chips; see IAutomationsDateFilterConfig.

dateFilterConfigOverridesByTab

Record<string, IDashboardDateFilterConfig | undefined>

(BETA) Dashboard-level common (whole-dashboard) date filter config override, keyed by tab identifier; from selectDateFilterConfigOverridesByTab.

dateFilterConfigs

IDashboardDateFilterConfigItem[]

(BETA) Per-dataset (dimension) date filter config overrides for the active tab; from selectDateFilterConfigsOverrides.

dateFilterConfigsByTab

Record<string, IDashboardDateFilterConfigItem[]>

(BETA) Same as IAutomationsContextValue.dateFilterConfigs, keyed by tab identifier; from selectDateFilterConfigsOverridesByTab.

dateFilterContextConfig

IDashboardDateFilterConfig | undefined

(BETA) Persisted common date filter config for the active tab, used for its custom title; from selectPersistedDashboardFilterContextDateFilterConfig.

defaultSelectedFilters

FilterContextItem[]

(BETA) Automation-available filters with empty (all-values) filters removed, except restricted ones; preselects filters for a new automation. From selectAutomationDefaultSelectedFilters.

exportTimezones?

{ isTimezoneFeatureEnabled: boolean; allowUserOverrideInViewMode: boolean; configuredTimezoneId: string | undefined; workspaceTimezone: string | undefined; effectiveTimezone: string | undefined; scheduledExportTimezone: string | undefined; }

(BETA) (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

(BETA) External (non-workspace) recipient the dialog is scoped to, when opened via an external share link; from selectExternalRecipient.

features

{ canCreateAutomation: boolean; enableAlertOncePerInterval: boolean; enableAnomalyDetectionAlert: boolean; canUseAiAssistant: boolean; canManageWorkspace: boolean; enableSlideshowExports: boolean; enableAutomationEvaluationMode: boolean; }

(BETA) Feature flags and permissions gating automation dialog behavior.

getAttributeFilterDisplayForm

(displayForm: ObjRef) => IAttributeDisplayFormMetadataObject | undefined

(BETA) Looks up an attribute filter’s display form by ref, preferring the dashboard’s own attribute filter display forms before falling back to the workspace catalog; combines selectAttributeFilterDisplayFormsMap and selectAllCatalogDisplayFormsMap.

getCatalogAttributeByRef

(ref: ObjRef) => ICatalogAttribute | ICatalogDateAttribute | undefined

(BETA) Looks up a catalog attribute (or date attribute) by ref; backed by selectAllCatalogAttributesMap. Used to resolve attribute names for filter labels.

hiddenFilters

FilterContextItem[]

(BETA) Dashboard filters configured as hidden; from selectDashboardHiddenFilters.

isExecutionTimestampMode

boolean

(BETA) Whether the dashboard is opened at a past execution timestamp (a scheduled run’s historical snapshot); disables create/save actions in the dialogs. Derived from selectExecutionTimestamp.

isFilterRestricted

(filter: FilterContextItem) => boolean

(BETA) Whether the user may not read the object a filter filters by. Such a filter is kept in the automation, but the filter bar reports it as a count instead of rendering it.

isSecondaryTitleVisible

boolean

(BETA) Whether the dialog header renders a secondary title row below the main title; always true in the current hydration.

isWhiteLabeled

boolean

(BETA) Whether the dashboard is white-labeled (hides GoodData branding and help links); from selectIsWhiteLabeled.

locale

ILocale

(BETA) Workspace locale for message formatting and number/date localization; from selectLocale.

lockedFilters

FilterContextItem[]

(BETA) Dashboard filters configured as read-only (locked); from selectDashboardLockedFilters.

maxAutomationsRecipients

number

(BETA) Maximum number of recipients allowed on an automation, derived from the recipient-count entitlement (Infinity when the unlimited-recipients entitlement is present); from selectMaxAutomationRecipients.

measureValueFilterConfigs

IDashboardMeasureValueFilterConfig[]

(BETA) Dashboard-level measure value filter config overrides for the active tab; from selectMeasureValueFilterConfigsOverrides.

measureValueFilterConfigsByTab

Record<string, IDashboardMeasureValueFilterConfig[]>

(BETA) Same as IAutomationsContextValue.measureValueFilterConfigs, keyed by tab identifier; from selectMeasureValueFilterConfigsOverridesByTab.

parameters

IAutomationsParameters

(BETA) Workspace parameter catalog and effective dashboard parameter values for automations; see IAutomationsParameters.

scheduleEmailDialogReturnFocusTo?

string

(BETA) (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

(BETA) Number formatting separators (decimal/thousands); from selectSeparators.

settings?

ISettings

(BETA) (Optional) Workspace/dashboard feature settings object; from selectSettings.

tabIds

string[]

(BETA) 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 readslocalIdentifier, and all of them already coalesce undefined to [].

timezone

string | undefined

(BETA) 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

(BETA) The workspace’s configured first day of the week; from selectWeekStart.

widgetExistsByRef

(ref: ObjRef | undefined) => boolean

(BETA) 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>

(BETA) Maps a widget’s localIdentifier to the localIdentifier of the tab that owns it.

Property details

IAutomationsContextValue.allowHourlyRecurrencepropertyBeta

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

Whether the workspace’s minimum-recurrence entitlement permits hourly schedules; derived from selectEntitlementMinimumRecurrenceMinutes.

allowHourlyRecurrence: boolean;

IAutomationsContextValue.attributeFilterConfigspropertyBeta

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

Dashboard-level attribute filter config overrides for the active tab; from selectAttributeFilterConfigsOverrides.

attributeFilterConfigs: IDashboardAttributeFilterConfig[];

IAutomationsContextValue.attributeFilterConfigsByTabpropertyBeta

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

Same as IAutomationsContextValue.attributeFilterConfigs, keyed by tab identifier; from selectAttributeFilterConfigsOverridesByTab.

attributeFilterConfigsByTab: Record<string, IDashboardAttributeFilterConfig[]>;

IAutomationsContextValue.attributeFilterSelectionTypeMappropertyBeta

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

Attribute filter selection type (single/multi) by local identifier for the active tab; from selectAttributeFilterConfigsSelectionTypeMap.

attributeFilterSelectionTypeMap: Map<string, DashboardAttributeFilterSelectionType | undefined>;

IAutomationsContextValue.attributeFilterSelectionTypeMapByTabpropertyBeta

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

Same as IAutomationsContextValue.attributeFilterSelectionTypeMap, keyed by tab identifier; from selectAttributeFilterConfigsSelectionTypeMapByTab.

attributeFilterSelectionTypeMapByTab: Record<string, Map<string, DashboardAttributeFilterSelectionType | undefined>>;

IAutomationsContextValue.automationAvailableFilterspropertyBeta

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

Dashboard filters available to an automation — hidden filters removed, common date filter included; from selectAutomationAvailableDashboardFilters.

automationAvailableFilters: FilterContextItem[];

IAutomationsContextValue.automationFiltersByTabpropertyBeta

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

Automation-available filters structured per dashboard tab, for whole-dashboard automations on a tabbed dashboard; from selectAutomationFiltersByTab.

automationFiltersByTab: IAutomationFiltersTab[];

IAutomationsContextValue.availableFilterspropertyBeta

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

Dashboard’s applied filters with cross-filtering filters removed; from selectAllDashboardFiltersWithoutCrossFiltering.

availableFilters: FilterContextItem[];

IAutomationsContextValue.catalogAttributespropertyBeta

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

Workspace attribute catalog, including computed attributes; from selectCatalogAttributesWithComputed.

catalogAttributes: ICatalogAttribute[];

IAutomationsContextValue.catalogDateDatasetspropertyBeta

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

Workspace date dataset catalog; from selectCatalogDateDatasets.

catalogDateDatasets: ICatalogDateDataset[];

IAutomationsContextValue.catalogMeasurespropertyBeta

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

Workspace measure catalog; from selectCatalogMeasures.

catalogMeasures: ICatalogMeasure[];

IAutomationsContextValue.commonDateFilterIdpropertyBeta

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

Local identifier of the dashboard’s common date filter, when the automation-available filters include one; from selectAutomationCommonDateFilterId.

commonDateFilterId: string | undefined;

IAutomationsContextValue.currentUserpropertyBeta

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

The logged-in user; from selectCurrentUser.

currentUser: IUser;

IAutomationsContextValue.dateFilterConfigpropertyBeta

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

Date filter granularities and presets for automation date filter chips; see IAutomationsDateFilterConfig.

dateFilterConfig: IAutomationsDateFilterConfig;

IAutomationsContextValue.dateFilterConfigOverridesByTabpropertyBeta

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

Dashboard-level common (whole-dashboard) date filter config override, keyed by tab identifier; from selectDateFilterConfigOverridesByTab.

dateFilterConfigOverridesByTab: Record<string, IDashboardDateFilterConfig | undefined>;

IAutomationsContextValue.dateFilterConfigspropertyBeta

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

Per-dataset (dimension) date filter config overrides for the active tab; from selectDateFilterConfigsOverrides.

dateFilterConfigs: IDashboardDateFilterConfigItem[];

IAutomationsContextValue.dateFilterConfigsByTabpropertyBeta

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

Same as IAutomationsContextValue.dateFilterConfigs, keyed by tab identifier; from selectDateFilterConfigsOverridesByTab.

dateFilterConfigsByTab: Record<string, IDashboardDateFilterConfigItem[]>;

IAutomationsContextValue.dateFilterContextConfigpropertyBeta

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

Persisted common date filter config for the active tab, used for its custom title; from selectPersistedDashboardFilterContextDateFilterConfig.

dateFilterContextConfig: IDashboardDateFilterConfig | undefined;

IAutomationsContextValue.defaultSelectedFilterspropertyBeta

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

Automation-available filters with empty (all-values) filters removed, except restricted ones; preselects filters for a new automation. From selectAutomationDefaultSelectedFilters.

defaultSelectedFilters: FilterContextItem[];

IAutomationsContextValue.exportTimezonespropertyBeta

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

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.

exportTimezones?: {
        isTimezoneFeatureEnabled: boolean;
        allowUserOverrideInViewMode: boolean;
        configuredTimezoneId: string | undefined;
        workspaceTimezone: string | undefined;
        effectiveTimezone: string | undefined;
        scheduledExportTimezone: string | undefined;
    };

IAutomationsContextValue.externalRecipientpropertyBeta

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

External (non-workspace) recipient the dialog is scoped to, when opened via an external share link; from selectExternalRecipient.

externalRecipient: string | undefined;

IAutomationsContextValue.featurespropertyBeta

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

Feature flags and permissions gating automation dialog behavior.

features: {
        canCreateAutomation: boolean;
        enableAlertOncePerInterval: boolean;
        enableAnomalyDetectionAlert: boolean;
        canUseAiAssistant: boolean;
        canManageWorkspace: boolean;
        enableSlideshowExports: boolean;
        enableAutomationEvaluationMode: boolean;
    };

IAutomationsContextValue.getAttributeFilterDisplayFormpropertyBeta

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

Looks up an attribute filter’s display form by ref, preferring the dashboard’s own attribute filter display forms before falling back to the workspace catalog; combines selectAttributeFilterDisplayFormsMap and selectAllCatalogDisplayFormsMap.

getAttributeFilterDisplayForm: (displayForm: ObjRef) => IAttributeDisplayFormMetadataObject | undefined;

IAutomationsContextValue.getCatalogAttributeByRefpropertyBeta

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

Looks up a catalog attribute (or date attribute) by ref; backed by selectAllCatalogAttributesMap. Used to resolve attribute names for filter labels.

getCatalogAttributeByRef: (ref: ObjRef) => ICatalogAttribute | ICatalogDateAttribute | undefined;

IAutomationsContextValue.hiddenFilterspropertyBeta

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

Dashboard filters configured as hidden; from selectDashboardHiddenFilters.

hiddenFilters: FilterContextItem[];

IAutomationsContextValue.isExecutionTimestampModepropertyBeta

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

Whether the dashboard is opened at a past execution timestamp (a scheduled run’s historical snapshot); disables create/save actions in the dialogs. Derived from selectExecutionTimestamp.

isExecutionTimestampMode: boolean;

IAutomationsContextValue.isFilterRestrictedpropertyBeta

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

Whether the user may not read the object a filter filters by. Such a filter is kept in the automation, but the filter bar reports it as a count instead of rendering it.

isFilterRestricted: (filter: FilterContextItem) => boolean;

IAutomationsContextValue.isSecondaryTitleVisiblepropertyBeta

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

Whether the dialog header renders a secondary title row below the main title; always true in the current hydration.

isSecondaryTitleVisible: boolean;

IAutomationsContextValue.isWhiteLabeledpropertyBeta

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

Whether the dashboard is white-labeled (hides GoodData branding and help links); from selectIsWhiteLabeled.

isWhiteLabeled: boolean;

IAutomationsContextValue.localepropertyBeta

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

Workspace locale for message formatting and number/date localization; from selectLocale.

locale: ILocale;

IAutomationsContextValue.lockedFilterspropertyBeta

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

Dashboard filters configured as read-only (locked); from selectDashboardLockedFilters.

lockedFilters: FilterContextItem[];

IAutomationsContextValue.maxAutomationsRecipientspropertyBeta

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

Maximum number of recipients allowed on an automation, derived from the recipient-count entitlement (Infinity when the unlimited-recipients entitlement is present); from selectMaxAutomationRecipients.

maxAutomationsRecipients: number;

IAutomationsContextValue.measureValueFilterConfigspropertyBeta

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

Dashboard-level measure value filter config overrides for the active tab; from selectMeasureValueFilterConfigsOverrides.

measureValueFilterConfigs: IDashboardMeasureValueFilterConfig[];

IAutomationsContextValue.measureValueFilterConfigsByTabpropertyBeta

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

Same as IAutomationsContextValue.measureValueFilterConfigs, keyed by tab identifier; from selectMeasureValueFilterConfigsOverridesByTab.

measureValueFilterConfigsByTab: Record<string, IDashboardMeasureValueFilterConfig[]>;

IAutomationsContextValue.parameterspropertyBeta

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

Workspace parameter catalog and effective dashboard parameter values for automations; see IAutomationsParameters.

parameters: IAutomationsParameters;

IAutomationsContextValue.scheduleEmailDialogReturnFocusTopropertyBeta

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

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.

scheduleEmailDialogReturnFocusTo?: string;

IAutomationsContextValue.separatorspropertyBeta

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

Number formatting separators (decimal/thousands); from selectSeparators.

separators: ISeparators;

IAutomationsContextValue.settingspropertyBeta

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

Workspace/dashboard feature settings object; from selectSettings.

settings?: ISettings;

IAutomationsContextValue.tabIdspropertyBeta

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

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 readslocalIdentifier, and all of them already coalesce undefined to [].

tabIds: string[];

IAutomationsContextValue.timezonepropertyBeta

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

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.

timezone: string | undefined;

IAutomationsContextValue.weekStartpropertyBeta

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

The workspace’s configured first day of the week; from selectWeekStart.

weekStart: WeekStart;

IAutomationsContextValue.widgetExistsByRefpropertyBeta

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

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.

widgetExistsByRef: (ref: ObjRef | undefined) => boolean;

IAutomationsContextValue.widgetLocalIdToTabIdMappropertyBeta

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

Maps a widget’s localIdentifier to the localIdentifier of the tab that owns it.

widgetLocalIdToTabIdMap: Record<string, string>;

Related

AutomationsContextProvider
→
useAutomationsContext()
→
DashboardAttributeFilterSelectionType
→
FilterContextItem
→
IAttributeDisplayFormMetadataObject
→