This page describes important aspects of the deprecation of the sap.ui.core.Configuration
API facade. It shows a migration path away from the deprecated legacy APIs and towards their future-proof alternatives, provided the functionality is still meant for productive usage.
Configuration
The following is an alphabetical list of API methods on sap.ui.core.Configuration
. Meant as a compact and practical overview, it is derived from the API Reference, which may provide complementary information.
Legacy API Method on Configuration | New Module | Replace With |
---|---|---|
`applySettings` | \- | Deprecated without replacement. This API method, which was typically used via `sap.ui.getCore().getConfiguration().applySettings()`, is superseded by different dedicated facade modules addressing the corresponding topics. It's therefore not possible to use a generic pattern to replace these calls. Check the API documentation of [`sap.ui.core.Configuration`](https://ui5.sap.com/#/api/sap.ui.core.Configuration) and use the references below to find the correct replacement. |
`getAccessibility` | [`sap/ui/core/ControlBehavior`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior) | [`ControlBehavior.isAccessibilityEnabled()`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior%23methods/sap/ui/core/ControlBehavior.isAccessibilityEnabled) |
`getActiveTerminologies` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Localization.getActiveTerminologies()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.getActiveTerminologies) |
`getAllowlistService` | [`sap/ui/security/Security`](https://ui5.sap.com/#/api/module:sap/ui/security/Security) | [`Security.getAllowlistService()`](https://ui5.sap.com/#/api/module:sap/ui/security/Security%23methods/sap/ui/security/Security.getAllowlistService) |
`getAnimation` | [`sap/ui/core/ControlBehavior`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior) | [`ControlBehavior.getAnimationMode()`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior%23methods/sap/ui/core/ControlBehavior.getAnimationMode) |
`getAnimationMode` | [`sap/ui/core/ControlBehavior`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior) | [`ControlBehavior.getAnimationMode()`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior%23methods/sap/ui/core/ControlBehavior.getAnimationMode) |
`getAppCacheBuster` | \- | Deprecated without replacement |
`getAppCacheBusterMode` | \- | Deprecated without replacement |
`getApplication` | \- | Deprecated without replacement. Use [`sap/ui/core/ComponentSupport`](https://ui5.sap.com/#/api/module:sap/ui/core/ComponentSupport) instead. See also [Declarative API for Initial Components](/docs/04_Essentials/declarative-api-for-initial-components-82a0fce.html). |
`getAutoAriaBodyRole` | \- | Deprecated without replacement |
`getCalendarType` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getCalendarType()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getCalendarType) |
`getCalendarWeekNumbering` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getCalendarWeekNumbering()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getCalendarWeekNumbering) |
`getCompatibilityVersion` | \- | Deprecated without replacement |
`getDebug` | \- | Deprecated without replacement |
`getFileShareSupport` | \- | Deprecated without replacement |
`getFiori2Adaptation` | \- | Deprecated without replacement |
`getFlexibilityServices` | \- | Deprecated without replacement |
`getFormatLocale` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getLanguageTag()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getLanguageTag) The new API returns an [`sap/base/i18n/LanguageTag`](https://ui5.sap.com/#/api/module:sap/base/i18n/LanguageTag). There are two possibilities to replace the deprecated API calls using the new formatting API: - Either you replace the deprecated API by transforming the retrieved new `LanguageTag` into an [`sap/ui/core/Locale`](https://ui5.sap.com/#/api/sap.ui.core.Locale). To do so, require `sap/ui/core/Locale` and pass the `LanguageTag` as a parameter to the `Locale` constructor. - Alternatively, you adjust the usage of the locale to the new `LanguageTag` API. > ### Example: > ``` > // either transform LanguageTag into Locale and use as before > sap.ui.require([ > "sap/base/i18n/Formatting", > "sap/ui/core/Locale" > ], (Formatting, Locale) => { > // Transform LanguageTag to Locale > const oFormatLocale = new Locale(Formatting.getLanguageTag()); > const sFormatLanguage = oFormatLocale.getLanguage(); > }); > > // or adjust usage of Locale to LanguageTag API > sap.ui.require([ > "sap/base/i18n/Formatting" > ], (Formatting) => { > const oFormatLanguageTag = Formatting.getLanguageTag(); > const sFormatLanguage = oFormatLanguageTag.language; > }); > ``` |
`getFormatSettings` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/Summary) The `getFormatSettings` API is superseded by the `Formatting` facade itself. > ### Example: > ``` > sap.ui.require([ > "sap/base/i18n/Formatting", > "sap/base/i18n/date/CalendarType" > ], (Formatting, CalendarType) => { > Formatting.setCalendarType(CalendarType.Islamic); > }); > ``` |
`getFrameOptions` | [`sap/ui/security/Security`](https://ui5.sap.com/#/api/module:sap/ui/security/Security) | [`Security.getFrameOptions()`](https://ui5.sap.com/#/api/module:sap/ui/security/Security%23methods/sap/ui/security/Security.getFrameOptions) |
`getInspect` | \- | Deprecated without replacement |
`getLanguage` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Localization.getLanguage()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.getLanguage) |
`getLanguageTag` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | `Localization.getLanguageTag().toString()` |
`getLocale` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Formatting.getLanguageTag()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getLanguageTag) The new API returns an [`sap/base/i18n/LanguageTag`](https://ui5.sap.com/#/api/module:sap/base/i18n/LanguageTag). There are two possibilities to replace the deprecated API calls using the new formatting API: - Either you replace the deprecated API by transforming the retrieved new `LanguageTag` into an [`sap/ui/core/Locale`](https://ui5.sap.com/#/api/sap.ui.core.Locale). To do so, require `sap/ui/core/Locale` and pass the `LanguageTag` as a parameter to the `Locale` constructor. - Alternatively, you adjust the usage of the locale to the new `LanguageTag` API. > ### Example: > ``` > // either transform LanguageTag into Locale and use as before > sap.ui.require([ > "sap/base/i18n/Localization", > "sap/ui/core/Locale" > ], (Localization, Locale) => { > // Transform LanguageTag to Locale > const oLocale = new Locale(Localization.getLanguageTag()); > const sLanguage = oLocale.getLanguage(); > }); > > // or adjust usage of Locale to LanguageTag API > sap.ui.require([ > "sap/base/i18n/Localization" > ], (Localization) => { > const oLanguageTag = Localization.getLanguageTag(); > const sLanguage = oLanguageTag.language; > }); > ``` |
`getManifestFirst` | \- | Deprecated without replacement |
`getNoDuplicateIds` | \- | Deprecated without replacement |
`getOriginInfo` | \- | Deprecated without replacement |
`getRootComponent` | \- | Deprecated without replacement |
`getRTL` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Localization.getRTL()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.getRTL) |
`getSAPLogonLanguage` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Localization.getSAPLogonLanguage()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.getSAPLogonLanguage) |
`getSecurityTokenHandlers` | [`sap/ui/security/Security`](https://ui5.sap.com/#/api/module:sap/ui/security/Security) | [`Security.getSecurityTokenHandlers()`](https://ui5.sap.com/#/api/module:sap/ui/security/Security%23methods/sap/ui/security/Security.getSecurityTokenHandlers) |
`getStatisticsEnabled` | \- | Deprecated without replacement |
`getTheme` | [`sap/ui/core/Theming`](https://ui5.sap.com/#/api/module:sap/ui/core/Theming) | [`Theming.getTheme()`](https://ui5.sap.com/#/api/module:sap/ui/core/Theming%23methods/sap/ui/core/Theming.getTheme) |
`getTimezone` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Localization.getTimezone()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.getTimezone) |
`getUIDPrefix` | [`sap/ui/base/ManagedObjectMetadata`](https://ui5.sap.com/#/api/sap.ui.base.ManagedObjectMetadata) | [`ManagedObjectMetadata.getUIDPrefix()`](https://ui5.sap.com/#/api/sap.ui.base.ManagedObjectMetadata%23methods/sap.ui.base.ManagedObjectMetadata.getUIDPrefix) |
`getVersion` | [`sap/ui/VersionInfo`](https://ui5.sap.com/#/api/module:sap/ui/VersionInfo) | [`VersionInfo.load()`](https://ui5.sap.com/#/api/module:sap/ui/VersionInfo%23methods/sap/ui/VersionInfo.load) The `getVersion` method always returned the OpenUI5 version. Check the samples below on how to get either the SAPUI5 or OpenUI5 version. For more information, see [Versioning and Maintenance of OpenUI5](/docs/02_Read-Me-First/versioning-and-maintenance-of-openui5-91f0214.html). > ### Example: > ``` > sap.ui.require([ > "sap/ui/VersionInfo", > "sap/base/util/Version" > ], function(VersionInfo, VersionUtil) { > // access the SAPUI5 version at runtime > VersionInfo.load().then(function(oCurrentVersionInfo) { > const oSAPUI5Version = new VersionUtil(oCurrentVersionInfo.version); > // ... > }); > > // access the OpenUI5 version (core version) at runtime > VersionInfo.load("sap.ui.core").then(function(oCurrentVersionInfo) { > const oOpenUI5Version = new VersionUtil(oCurrentVersionInfo.version); > // ... > }); > }); > ``` |
`getWhitelistService` | [`sap/ui/security/Security`](https://ui5.sap.com/#/api/module:sap/ui/security/Security) | [`Security.getAllowlistService()`](https://ui5.sap.com/#/api/module:sap/ui/security/Security%23methods/sap/ui/security/Security.getAllowlistService) |
`setAnimationMode` | [`sap/ui/core/ControlBehavior`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior) | [`ControlBehavior.setAnimationMode()`](https://ui5.sap.com/#/api/module:sap/ui/core/ControlBehavior%23methods/sap/ui/core/ControlBehavior.setAnimationMode) |
`setCalendarType` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setCalendarType()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setCalendarType) |
`setCalendarWeekNumbering` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setCalendarWeekNumbering()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setCalendarWeekNumbering) |
`setFormatLocale` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setLanguageTag()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setLanguageTag) The deprecated API only accepted a string, whereas the new API also accepts an [`sap/base/i18n/LanguageTag`](https://ui5.sap.com/#/api/module:sap/base/i18n/LanguageTag). |
`setLanguage` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Localization.setLanguage()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.setLanguage) |
`setRTL` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Localization.setRTL()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.setRTL) |
`setSecurityTokenHandlers` | [`sap/ui/security/Security`](https://ui5.sap.com/#/api/module:sap/ui/security/Security) | [`Security.setSecurityTokenHandlers()`](https://ui5.sap.com/#/api/module:sap/ui/security/Security%23methods/sap/ui/security/Security.setSecurityTokenHandlers) |
`setTheme` | [`sap/ui/core/Theming`](https://ui5.sap.com/#/api/module:sap/ui/core/Theming) | [`Theming.setTheme()`](https://ui5.sap.com/#/api/module:sap/ui/core/Theming%23methods/sap/ui/core/Theming.setTheme) |
`setTimezone` | [`sap/base/i18n/Localization`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization) | [`Localization.setTimezone()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.setTimezone) |
FormatSettings
In legacy code, a configuration object that bundled certain format settings of UI5, was often retrieved by calls such as sap.ui.core.Configuration.getFormatSettings()
, with the following methods then called on that FormatSettings
object.
Legacy API Method on FormatSettings | New Module | Replace With |
---|---|---|
`addCustomCurrencies` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.addCustomCurrencies()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.addCustomCurrencies) |
`getCustomCurrencies` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getCustomCurrencies()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getCustomCurrencies) |
`getDatePattern` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getDatePattern()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getDatePattern) |
`getFormatLocale` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getLanguageTag()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getLanguageTag) The new API returns an [`sap/base/i18n/LanguageTag`](https://ui5.sap.com/#/api/module:sap/base/i18n/LanguageTag). There are two possibilities to replace the deprecated API calls using the new formatting API. See the entry for `getFormatLocale` above. |
`getLegacyDateCalendarCustomizing` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getCustomIslamicCalendarData()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getCustomIslamicCalendarData) |
`getNumberSymbol` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getNumberSymbol()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getNumberSymbol) |
`getTimePattern` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getTimePattern()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getTimePattern) |
`getTrailingCurrencyCode` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.getTrailingCurrencyCode()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.getTrailingCurrencyCode) |
`setCustomCurrencies` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setCustomCurrencies()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setCustomCurrencies) |
`setDatePattern` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setDatePattern()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setDatePattern) |
`setFirstDayOfWeek` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setCalendarWeekNumbering()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setCalendarWeekNumbering) |
`setLegacyDateCalendarCustomizing` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setCustomIslamicCalendarData()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setCustomIslamicCalendarData) |
`setLegacyDateFormat` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setABAPDateFormat()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setABAPDateFormat) This renaming \(along with similar ones for `setLegacyNumberFormat` and `setLegacyTimeFormat`\), has been done to reflect their relation to SAP ABAP back ends. Consequently, the corresponding change event parameter has been named `ABAPDateFormat` \(and `ABAPNumberFormat` or `ABAPTimeFormat`, respectively\). Also refer to [`sap/base/i18n/Formatting$ChangeEvent`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting$ChangeEvent) for a detailed breakdown of all available change event parameters. |
`setLegacyNumberFormat` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setABAPNumberFormat()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setABAPNumberFormat) See information for `setLegacyDateFormat`. |
`setLegacyTimeFormat` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setABAPTimeFormat()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setABAPTimeFormat) See information for `setLegacyDateFormat`. |
`setNumberSymbol` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setNumberSymbol()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setNumberSymbol) |
`setTimePattern` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setTimePattern()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setTimePattern) |
`setTrailingCurrencyCode` | [`sap/base/i18n/Formatting`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting) | [`Formatting.setTrailingCurrencyCode()`](https://ui5.sap.com/#/api/module:sap/base/i18n/Formatting%23methods/sap/base/i18n/Formatting.setTrailingCurrencyCode) |