IBackendCapabilities
Analytical Backend communicates its capabilities via objects of this type. In return, the capabilities can then be used by applications to enable / disable particular features.
export interface IBackendCapabilities
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (Optional) Indicates whether the UI supports multiple interactions per attribute and measure. IF set to true, the user interface (UI) provides functionality for managing multiple interactions per attribute and measure. If set to false or undefined, the UI does not support these features. | ||
boolean | (Optional) Indicates whether backend allows objects with damaged references. | ||
boolean | (Optional) Indicates whether the backend is capable to calculate and include grand totals in the resulting data view. | ||
boolean | (Optional) Indicates whether the backend is capable to calculate and include native totals (aka rollups) in the resulting data view. | ||
boolean | (Optional) Indicates whether the backend is capable to calculate and include subtotals in the resulting data view. | ||
boolean | (Optional) Indicates whether the backend is capable to calculate and include totals in the resulting data view. | ||
boolean | (Optional) Indicates whether backend can execute an existing, persistent insight by reference. | ||
boolean | (Optional) Indicates whether backend can export data to CSV file. | ||
boolean | (Optional) Indicates whether backend can export data to Excel. | ||
boolean | (Optional) Indicates whether the backend is capable to sort the result data view. | ||
boolean | (Optional) Indicates whether backend can transform an existing result into a different shape / sorting / totals. | ||
boolean | (Optional) Indicates whether backends supports displaying message to inform workspace managers about having access to the shared object. | ||
boolean | (Optional) Indicates whether backend’s identifiers are scoped to a type. | ||
number | (Optional) Indicates maximum result dimensions that the backend is able to produce. | ||
boolean | (Optional) Indicates whether backend supports control of access to the MD objects | ||
boolean | (Optional) Indicates whether backend supports limiting of attribute filter elements by a metric, attribute, fact. | ||
supportsAttributeFilterElementsLimitingByDependentDateFilters? | boolean | (Optional) Indicates whether backend supports limiting of attribute filter elements by dependent date filters. | |
boolean | (Optional) Indicates whether the UI supports attribute hierarchies. If set to true, the user interface (UI) provides functionality for managing attribute hierarchies If set to false or undefined, the UI does not support attribute hierarchies features. | ||
boolean | (Optional) Indicates whether backend supports bootstrap resource that returns initial app data. | ||
boolean | (Optional) Indicates whether backend supports to circular dependencies in dependent filters. | ||
boolean | (Optional) Indicates whether backend supports cross filtering. | ||
boolean | (Optional) Indicates whether backend supports adding CSV datasets and switching between them. | ||
boolean | (Optional) Indicates whether backend supports custom color palettes. | ||
boolean | (Optional) Indicates whether backend supports element query parent filtering. | ||
boolean | (Optional) Indicates whether the backend can recognize attribute elements by URI. | ||
boolean | (Optional) Indicates whether dackend supports enumerating datetime attributes. | ||
boolean | (Optional) Indicates whether backend supports virtual “Everyone” group that is used when we want to assign permissions for all current and future users of the platform. | ||
boolean | (Optional) Indicates whether backend supports downloading of files that will be used for debugging. Indicates whether backend supports retrieving of data that will be used for debugging. | ||
boolean | (Optional) Indicates whether backend supports returning of the valid elements (values) for generic date attributes (Day of Week, Month of Year, etc.). | ||
boolean | (Optional) Indicates whether backend supports granular access controls of metadata objects or if permissions are tied to the user role. | ||
boolean | (Optional) Indicates whether the UI supports hidden and locked filters. If set to true, the user interface (UI) provides functionality for managing hidden and locked filters. If set to false or undefined, the UI does not support these features. | ||
boolean | (Optional) Indicates whether backend supports hierarchical workspaces | ||
boolean | (Optional) Indicates whether backend supports hyperlink attribute labels. | ||
boolean | (Optional) Indicates whether backend supports inline measures in execution. | ||
boolean | (Optional) Indicates whether backend supports to keep selection of dependent filters. | ||
boolean | (Optional) Indicates whether backend supports a special dashboard-specific KPI Widget. | ||
boolean | (Optional) Indicates whether backends supports locking of metadata objects that prevents their edit by other users than admins. | ||
boolean | (Optional) Indicates whether backend supports to have multiple date filters. | ||
boolean | (Optional) Indicates whether backend supports non production data sets. | ||
boolean | (Optional) Indicates whether the backend is capable to address objects using URIs | ||
boolean | (Optional) Indicates whether backend supports organization settings. | ||
boolean | (Optional) Indicates whether backend supports filtering object by owner/creator. | ||
boolean | (Optional) Indicates whether backend supports ranking filters. | ||
boolean | (Optional) Indicates whether backend supports ranking filters in combination with measure value filters (in the same execution). | ||
boolean | (Optional) Indicates whether backend supports rich text widgets. | ||
boolean | (Optional) Indicates whether backend supports separate numerical labels (display forms) for geo chart’s latitude and longitude. If false, string label with “latitude;longitude” values is expected. | ||
boolean | (Optional) Indicates whether backend supports setting connecting attribute in dependent filters. | ||
boolean | (Optional) Indicates whether backend supports executions listing all attribute values | ||
boolean | (Optional) Indicates whether backend supports to show elements filtered out by limiting filters. | ||
boolean | (Optional) Indicates whether backend supports to set dependencies for single-select filters. | ||
boolean | (Optional) Indicates whether backend supports time granularities (gdc.time.minute, gdc.time.hour); | ||
boolean | (Optional) Indicates whether backend supports Widget as standalone addressable entity. | ||
boolean | (Optional) Indicates whether backend supports only strict access control. |
Property details
IBackendCapabilities.allowMultipleInteractionsPerAttributeAndMeasureproperty
Indicates whether the UI supports multiple interactions per attribute and measure.
IF set to true, the user interface (UI) provides functionality for managing multiple interactions per attribute and measure. If set to false or undefined, the UI does not support these features.
allowMultipleInteractionsPerAttributeAndMeasure?: boolean;
IBackendCapabilities.allowsInconsistentRelationsproperty
Indicates whether backend allows objects with damaged references.
allowsInconsistentRelations?: boolean;
IBackendCapabilities.canCalculateGrandTotalsproperty
Indicates whether the backend is capable to calculate and include grand totals in the resulting data view.
canCalculateGrandTotals?: boolean;
IBackendCapabilities.canCalculateNativeTotalsproperty
Indicates whether the backend is capable to calculate and include native totals (aka rollups) in the resulting data view.
canCalculateNativeTotals?: boolean;
IBackendCapabilities.canCalculateSubTotalsproperty
Indicates whether the backend is capable to calculate and include subtotals in the resulting data view.
canCalculateSubTotals?: boolean;
IBackendCapabilities.canCalculateTotalsproperty
Indicates whether the backend is capable to calculate and include totals in the resulting data view.
canCalculateTotals?: boolean;
IBackendCapabilities.canExecuteByReferenceproperty
Indicates whether backend can execute an existing, persistent insight by reference.
canExecuteByReference?: boolean;
IBackendCapabilities.canExportCsvproperty
Indicates whether backend can export data to CSV file.
canExportCsv?: boolean;
IBackendCapabilities.canExportXlsxproperty
Indicates whether backend can export data to Excel.
canExportXlsx?: boolean;
IBackendCapabilities.canSortDataproperty
Indicates whether the backend is capable to sort the result data view.
canSortData?: boolean;
IBackendCapabilities.canTransformExistingResultproperty
Indicates whether backend can transform an existing result into a different shape / sorting / totals.
canTransformExistingResult?: boolean;
IBackendCapabilities.canWorkspaceManagerSeeEverySharedObjectproperty
Indicates whether backends supports displaying message to inform workspace managers about having access to the shared object.
canWorkspaceManagerSeeEverySharedObject?: boolean;
IBackendCapabilities.hasTypeScopedIdentifiersproperty
Indicates whether backend’s identifiers are scoped to a type.
hasTypeScopedIdentifiers?: boolean;
Remarks
They are unique only on type level. When working with backend that has type scoped identifiers it is essential to provide both identifier and type when using IdentifierRef.
If not specified then assume identifiers do not require type information in order to exactly identify an object.
IBackendCapabilities.maxDimensionsproperty
Indicates maximum result dimensions that the backend is able to produce.
maxDimensions?: number;
IBackendCapabilities.supportsAccessControlproperty
Indicates whether backend supports control of access to the MD objects
supportsAccessControl?: boolean;
IBackendCapabilities.supportsAttributeFilterElementsLimitingproperty
Indicates whether backend supports limiting of attribute filter elements by a metric, attribute, fact.
supportsAttributeFilterElementsLimiting?: boolean;
IBackendCapabilities.supportsAttributeFilterElementsLimitingByDependentDateFiltersproperty
Indicates whether backend supports limiting of attribute filter elements by dependent date filters.
supportsAttributeFilterElementsLimitingByDependentDateFilters?: boolean;
IBackendCapabilities.supportsAttributeHierarchiesproperty
Indicates whether the UI supports attribute hierarchies.
If set to true, the user interface (UI) provides functionality for managing attribute hierarchies If set to false or undefined, the UI does not support attribute hierarchies features.
supportsAttributeHierarchies?: boolean;
IBackendCapabilities.supportsBootstrapResourceproperty
Indicates whether backend supports bootstrap resource that returns initial app data.
supportsBootstrapResource?: boolean;
IBackendCapabilities.supportsCircularDependencyInFiltersproperty
Indicates whether backend supports to circular dependencies in dependent filters.
supportsCircularDependencyInFilters?: boolean;
IBackendCapabilities.supportsCrossFilteringproperty
Indicates whether backend supports cross filtering.
supportsCrossFiltering?: boolean;
IBackendCapabilities.supportsCsvUploaderpropertyDeprecated
Warning: This API is now obsolete.
No backend supports the CSV uploader any more. The capability is not read.
Indicates whether backend supports adding CSV datasets and switching between them.
supportsCsvUploader?: boolean;
IBackendCapabilities.supportsCustomColorPalettesproperty
Indicates whether backend supports custom color palettes.
supportsCustomColorPalettes?: boolean;
IBackendCapabilities.supportsElementsQueryParentFilteringproperty
Indicates whether backend supports element query parent filtering.
supportsElementsQueryParentFiltering?: boolean;
IBackendCapabilities.supportsElementUrisproperty
Indicates whether the backend can recognize attribute elements by URI.
supportsElementUris?: boolean;
IBackendCapabilities.supportsEnumeratingDatetimeAttributesproperty
Indicates whether dackend supports enumerating datetime attributes.
supportsEnumeratingDatetimeAttributes?: boolean;
IBackendCapabilities.supportsEveryoneUserGroupForAccessControlproperty
Indicates whether backend supports virtual “Everyone” group that is used when we want to assign permissions for all current and future users of the platform.
supportsEveryoneUserGroupForAccessControl?: boolean;
IBackendCapabilities.supportsExplainproperty
Indicates whether backend supports downloading of files that will be used for debugging. Indicates whether backend supports retrieving of data that will be used for debugging.
supportsExplain?: boolean;
IBackendCapabilities.supportsGenericDateAttributeElementsproperty
Indicates whether backend supports returning of the valid elements (values) for generic date attributes (Day of Week, Month of Year, etc.).
supportsGenericDateAttributeElements?: boolean;
IBackendCapabilities.supportsGranularAccessControlproperty
Indicates whether backend supports granular access controls of metadata objects or if permissions are tied to the user role.
supportsGranularAccessControl?: boolean;
IBackendCapabilities.supportsHiddenAndLockedFiltersOnUIproperty
Indicates whether the UI supports hidden and locked filters.
If set to true, the user interface (UI) provides functionality for managing hidden and locked filters. If set to false or undefined, the UI does not support these features.
supportsHiddenAndLockedFiltersOnUI?: boolean;
IBackendCapabilities.supportsHierarchicalWorkspacesproperty
Indicates whether backend supports hierarchical workspaces
supportsHierarchicalWorkspaces?: boolean;
IBackendCapabilities.supportsHyperlinkAttributeLabelsproperty
Indicates whether backend supports hyperlink attribute labels.
supportsHyperlinkAttributeLabels?: boolean;
IBackendCapabilities.supportsInlineMeasuresproperty
Indicates whether backend supports inline measures in execution.
supportsInlineMeasures?: boolean;
IBackendCapabilities.supportsKeepingDependentFiltersSelectionproperty
Indicates whether backend supports to keep selection of dependent filters.
supportsKeepingDependentFiltersSelection?: boolean;
IBackendCapabilities.supportsKpiWidgetproperty
Indicates whether backend supports a special dashboard-specific KPI Widget.
supportsKpiWidget?: boolean;
IBackendCapabilities.supportsMetadataObjectLockingproperty
Indicates whether backends supports locking of metadata objects that prevents their edit by other users than admins.
supportsMetadataObjectLocking?: boolean;
IBackendCapabilities.supportsMultipleDateFiltersproperty
Indicates whether backend supports to have multiple date filters.
supportsMultipleDateFilters?: boolean;
IBackendCapabilities.supportsNonProductionDatasetsproperty
Indicates whether backend supports non production data sets.
supportsNonProductionDatasets?: boolean;
IBackendCapabilities.supportsObjectUrisproperty
Indicates whether the backend is capable to address objects using URIs
supportsObjectUris?: boolean;
IBackendCapabilities.supportsOrganizationSettingsproperty
Indicates whether backend supports organization settings.
supportsOrganizationSettings?: boolean;
IBackendCapabilities.supportsOwnersproperty
Indicates whether backend supports filtering object by owner/creator.
supportsOwners?: boolean;
IBackendCapabilities.supportsRankingFilterproperty
Indicates whether backend supports ranking filters.
supportsRankingFilter?: boolean;
IBackendCapabilities.supportsRankingFilterWithMeasureValueFilterproperty
Indicates whether backend supports ranking filters in combination with measure value filters (in the same execution).
supportsRankingFilterWithMeasureValueFilter?: boolean;
IBackendCapabilities.supportsRichTextWidgetsproperty
Indicates whether backend supports rich text widgets.
supportsRichTextWidgets?: boolean;
IBackendCapabilities.supportsSeparateLatitudeLongitudeLabelsproperty
Indicates whether backend supports separate numerical labels (display forms) for geo chart’s latitude and longitude. If false, string label with “latitude;longitude” values is expected.
supportsSeparateLatitudeLongitudeLabels?: boolean;
IBackendCapabilities.supportsSettingConnectingAttributesproperty
Indicates whether backend supports setting connecting attribute in dependent filters.
supportsSettingConnectingAttributes?: boolean;
IBackendCapabilities.supportsShowAllAttributeValuesproperty
Indicates whether backend supports executions listing all attribute values
supportsShowAllAttributeValues?: boolean;
IBackendCapabilities.supportsShowingFilteredElementsproperty
Indicates whether backend supports to show elements filtered out by limiting filters.
supportsShowingFilteredElements?: boolean;
IBackendCapabilities.supportsSingleSelectDependentFiltersproperty
Indicates whether backend supports to set dependencies for single-select filters.
supportsSingleSelectDependentFilters?: boolean;
IBackendCapabilities.supportsTimeGranularitiesproperty
Indicates whether backend supports time granularities (gdc.time.minute, gdc.time.hour);
supportsTimeGranularities?: boolean;
IBackendCapabilities.supportsWidgetEntityproperty
Indicates whether backend supports Widget as standalone addressable entity.
supportsWidgetEntity?: boolean;
IBackendCapabilities.usesStrictAccessControlproperty
Indicates whether backend supports only strict access control.
usesStrictAccessControl?: boolean;
Remarks
It means that no one without proper permissions is able to get restricted MD object even knowing its URI.