Migration Information for Upgrading the Descriptor File

_version

V3 (1.32)

Needs to be updated in the manifest.json file when migrating to a new descriptor version:

• _version for V3 is 1.2.0

• _version for V4 is 1.3.0

• _version for V5 is 1.4.0 (see example)

sap.app/crossNavigation

V3 (1.32)

Contains navigation information and is a mandatory attribute in the manifest.json file for SAP Fiori apps; the attribute contains two sections:

• sap.app/crossNavigation/inbounds - Contains inbound intents and signature information

• sap.app/crossNavigation/outbounds - Contains required intents that are called explicitely by the app, for example, if a business process is split among different apps A and B. If A calls B, A has outbound the intent to address B.

sap.app/subTitle

V4 (1.34)

Added to the manifest.json file by using the {{...}} syntax

sap.app/crossNavigation/inbounds/<inboundname>/subTitle

V4 (1.34)

Used to overwrite the subTitle attribute per inbound; use the {{...}} syntax to add the attribute to the manifest.json file

sap.ui/fullWidth

V4 (1.34)

Indicates whether an app shall run in full screen mode (true)

sap.ui5/componentName

V4 (1.34)

Specifies the component name of the SAPUI5 app

This is the same as sap.app/id, that is, the same name as used in Component.js.

Example: If your Component.js file contains "hcm.emp.myleaverequests.Component", enter "hcm.emp.myleaverequests" in the componentName attribute.

sap.ui5/dependencies/components/<componentname>/lazy and dependencies/libs/<libname>/lazy

V4 (1.34)

If dependencies/components/<componentname>/lazy and dependencies/libs/<libname>/lazy are set to true, the attribute indicates in a SAP Fiori app that a dependency shall be lazy loaded (default is false), see the example for manifest.json for the SAP Fiori app.

Example for manifest.json for the SAP Fiori app:

"sap.ui5": {
   "_version": "1.2.0",
   ...
   "dependencies": {
        "minUI5Version": "1.34.0",
        "libs": {
            "sap.m": {
                "minVersion": "1.34.0"
            },
            "sap.ui.commons": {
                "minVersion": "1.34.0",
                "lazy": true
            }
        },
        "components": {
            "sap.ui.app.other": {
                "minVersion": "1.1.0"
                "lazy": true
            }
        }
    },

sapui5/routing/config/async

V4 (1.34)

General setting for routing that indicates how the views are loaded; if set to true, the views are loaded asynchronously (default is false)

For performance reasons, we recommend to always use the async setting. This recommendation implies that you have followed the SAPUI5 programming model in general and do not rely on any sync-execution depending event-orders.

sap.ui5/autoPrefixId

V4 (1.34)

For the UIComponent, this setting enables the auto-prefixing of IDs of ManagedObjects (controls or elements) which are created in the context of the createContent function or any other invocation of the Component.prototype.runAsOwner() function; to enable the auto-prefixing of IDs, set the attribute to true (default is false)

This attribute can be used to avoid prefixing the ID of the controls created in the createContent function of the UI component. Otherwise, you need to use the createId function of the UI component to make sure that the control ID is prefixed properly to avoid duplicate ID issues, see Handling IDs in UI Components.

The autoPrefixId replaces the overwriting of the getAutoPrefixId method by oComponent.createId.

sap.ui5/models/preload

V5 (1.38)

Defines whether or not the model is initialized (preloaded) before the component instance is created and while loading the component preload and its dependencies