Supported UI5 versions

PreBilt is a SAPUI5-based mobile warehousing application designed for SAP Warehouse Management (WM) and Inventory Management (IM) modules. This document outlines the SAPUI5 version support and library loading strategies available in PreBilt.

SAPUI5 library loading options

PreBilt supports five distinct methods for loading SAPUI5 libraries, each suited for different deployment scenarios and development needs:

Local SAPUI5 libraries

Loading SAPUI5 libraries locally provides complete control over the version used and ensures offline capability. This option should be used when:

Production environments with strict version control requirements
Offline or limited connectivity scenarios
When specific SAPUI5 version features are required
Performance-critical deployments where network latency must be minimised

Configuration:

The application references SAPUI5 libraries stored within the application package. The bootstrap configuration in index.html points to local resources:

<script id="sap-ui-bootstrap"
    src="sapui5/resources/sap-ui-core.js"
    data-sap-ui-libs="sap.m, sap.ui.layout, sap.ui.unified, sap.ui.comp, sap.suite.ui.commons"
    data-sap-ui-theme="sap_belize"
    data-sap-ui-compatversion="edge"
    data-sap-ui-preload="async"
    data-sap-ui-resourceroots='{tctm.tctm_wm_base": "./", "tctm": "./apps/"}'
    data-sap-ui-language="en"
    data-sap-ui-noDuplicateIds="false"
    onerror="alert('Script Load Error')">
</script>

Advantages

No external dependencies
Consistent performance
Works in offline scenarios
Full control over SAPUI5 version

Considerations

Larger application package size
Manual updates required for SAPUI5 version changes
Must maintain library files within the project

SAP CDN (content delivery network)

Loading SAPUI5 from SAP's CDN is ideal for development and testing environments. This option should be used when:

Local development environments
Testing and quality assurance
Rapid prototyping
When evaluating new SAPUI5 versions

Configuration

The bootstrap configuration references the SAP CDN:

<script id="sap-ui-bootstrap"
    src="https://ui5.sap.com/resources/sap-ui-core.js"
    data-sap-ui-libs="sap.m, sap.ui.core"
    data-sap-ui-theme="sap_fiori_3"
    data-sap-ui-resourceroots='{"com.company.prebuilt": "./"}'
    data-sap-ui-async="true">
</script>

CDN URL patterns

Latest stable version: https://ui5.sap.com/resources/sap-ui-core.js
Specific version: https://ui5.sap.com/[VERSION]/resources/sap-ui-core.js
Example: https://ui5.sap.com/1.120.0/resources/sap-ui-core.js
Latest patch of a version: https://ui5.sap.com/1.120/resources/sap-ui-core.js
OpenUI5 CDN: https://openui5.hana.ondemand.com/[VERSION]/resources/sap-ui-core.js

CDN version availability

All patch versions of SAPUI5 starting from version 1.26 are available and can be found via the SAPUI5 Version Overview. These versions are delivered through the Akamai CDN to ensure optimal global performance.

Note

SAP removes UI5 versions from the CDN one year after their end of maintenance. Applications using outdated versions will stop working. Regular updates to supported versions are essential for security and continued availability.

Advantages

Always access to latest features
No local library maintenance
Smaller application package
Easy version switching for testing
Global CDN performance through Akamai network

Considerations

Requires internet connectivity
Potential latency issues
Not suitable for production environments
CDN availability dependency
Versions removed after end of maintenance period

SAP system deployed UI5 version

When running directly on the SAP system as a Fiori application, PreBilt can use the SAPUI5 version deployed to the SAP Frontend Server (FES). This option should be used when:

Direct BSP application access
Testing on SAP development systems

Configuration

The bootstrap configuration uses the system's root resources path:

<script id="sap-ui-bootstrap"
    src="/resources/sap-ui-core.js"
    data-sap-ui-libs="sap.m, sap.ui.layout, sap.ui.unified, sap.ui.comp, sap.suite.ui.commons, sap.ui.table, sap.viz"
    data-sap-ui-theme="sap_belize"
    data-sap-ui-compatversion="edge"
    data-sap-ui-preload="async"
    data-sap-ui-async="true"
    data-sap-ui-resourceroots='{
        "tctm.tctm_wm_base": "./",
        "tctm": "./apps/"
    }'
    data-sap-ui-language="en"
    data-sap-ui-noDuplicateIds="false"
    onerror="alert('Script Load Error')">
</script>

Checking the system UI5 version

To verify which SAPUI5 version is deployed on your SAP system via /UI5/UI5_REPOSITORY_LOAD:

Open any Fiori application in the browser
Open the browser console (F12)
Execute: sap.ui.version
This returns the exact version installed on the FES

Version dependencies

The available SAPUI5 version depends on the Frontend Server (FES) version
FES updates are typically aligned with SAP NetWeaver releases
Version can vary between development, quality, and production systems

Advantages

No additional deployment steps required
Uses officially supported SAP system version
Consistent with system landscape
No external dependencies

Considerations

Limited to the version installed on the system
May vary between system landscapes (DEV/QA/PROD)
Requires regular FES updates for latest features
Version might be older than current CDN releases

Bundled libraries for Android APK

When building PreBilt as a native Android application using Capacitor, SAPUI5 libraries must be bundled within the APK for optimal performance and offline functionality. Use this option when:

Native Android deployment via Capacitor
Offline-first mobile applications
Enterprise mobile device management (MDM) deployments
Warehouse environments with unreliable connectivity

SAPUI5 version compatibility

Minimum required version

PreBilt requires a minimum SAPUI5 version of 1.84.0 due to dependencies on:

Enhanced mobile controls
Responsive table features
Modern theme support

Recommended Versions

Development: Latest stable version from CDN
Production: LTS (Long Term Support) versions
- 1.84.x (Check maintenance status)
- 1.96.x (LTS)
- 1.108.x (LTS)
- 1.120.x (Latest LTS)

CDN Version Maintenance Status

SAP follows a strict maintenance strategy for CDN-hosted versions:

Active Maintenance Policy:

Versions are maintained for their official support period
After end of maintenance + 1 year, versions are removed from CDN
Regular security patches during maintenance period
Check current status: https://sapui5.hana.ondemand.com/versionoverview.html

Troubleshooting

Common Issues and Solutions

Resources not loading in Fiori launchpad

Verify /UI5/UI5_REPOSITORY_LOAD execution completed successfully
Check ICF services are active: /sap/bc/ui5_ui5/
Ensure proper authorizations for UI5 repository access

CDN access blocked in corporate network

Configure proxy settings
Switch to local library loading
Request firewall exceptions for ui5.sap.com

APK crashes or shows blank screen

Verify all SAPUI5 resources are copied to /sapui5/resources
Check that the path in index.html matches: src="sapui5/resources/sap-ui-core.js"
Enable Chrome DevTools debugging via chrome://inspect
Verify all required libraries are included in the sapui5 directory

Migration Guidelines

Upgrading SAPUI5 Versions

Assessment Phase
1. Check version maintenance status at https://sapui5.hana.ondemand.com/versionoverview.html
2. Review release notes for breaking changes
3. Identify deprecated API usage
4. Verify CDN availability for target version
Testing Phase
1. Test with new version using CDN first
2. Validate all warehouse operations
3. Check mobile device compatibility
4. Test specific patch versions before production
Deployment Phase
1. Update local libraries if applicable
2. Modify version references in configuration
3. Deploy through standard change management
4. Update CDN URLs to specific patch versions for stability

Support and Resources

SAPUI5 SDK: https://ui5.sap.com/
Version Overview: https://ui5.sap.com/versionoverview.html

Choosing the appropriate SAPUI5 loading strategy and version for PreBilt depends on your deployment scenario, performance requirements, and organizational standards. For native Android deployments via Capacitor, bundling UI5 libraries ensures optimal performance and reliability in warehouse environments. Regular version assessments and updates ensure optimal performance and access to the latest features while maintaining stability for critical warehouse operations.

PreviousPrerequisites and assumptions NextRoles and responsibilities in a PreBilt implementation

Last updated 9 hours ago

Was this helpful?