start_url

Start page of your app, if available

$schema

JSON schema URI

id

A mandatory attribute that has to be provided in dot notation and specifies an ID for the project that must be unique in the system. It must match the namespace provided in the corresponding Component.js.

If, for example, a module is instantiated there as follows:

   return UIComponent.extend("sap.ui.demo.walkthrough.Component", {

      metadata : {
         manifest: "json"
      },
   ...

then its id would be sap.ui.demo.walkthrough

It's used as a reference point for most operations involving the manifest. If the project is the app variant of an existing application, sap.app/id is the ID of this app variant. The ID of the underlying application is then provided in sap.ui5/componentName.

type

A mandatory attribute. The following values are possible:

• application: use if your manifest.json describes a UI5 application. For an example how to use a manifest.json for UI5 applications, see Step 10: Descriptor for Applications

• component: use if your manifest.json describes a reuse component that is used in several apps. For further reuse component-specific configuration options, see Descriptor for Components (Inside Libraries).

• library: use if your manifest.json describes a UI5 library. For further library-specific configuration options, see Descriptor for Libraries.

• card: use if your manifest.json describes a UI5 card. For further card-specific configuration options, see Integration Cards.

i18n

The i18n property is an optional attribute and contains one of the following:

• A URL string to the properties file that contains the text symbols for the manifest; the URL is interpreted relative to the manifest.

  Note

  The path to the i18n file must not exceed 100 characters.

• An object that has been defined as described in Supported Locales and Fallback Chain and Terminologies.

  Note

  The sap.app/i18n section only supports terminologies for Components. Library manifests do not support additional terminologies.

If the manifest contains placeholders in {{...}} syntax, but no i18n attribute has been provided, the default value i18n/i18n.properties is used to request a ResourceBundle.

applicationVersion

Mandatory version of the app (semantic version with the following format major.minor.patch)

embeds

Array of relative paths to the nested manifest.json files; attribute is mandatory if a nested manifest.json exists

embeddedBy

Relative path back to the manifest.json file of an embedding component or library; attribute is mandatory for a nested manifest.json

title

Mandatory attribute; to make this property language dependent (recommended), use a key in double curly brackets: {{key}}

subTitle

Subtitle; to make this property language dependent (recommended), use a key in double curly brackets: {{key}}

shortTitle

Short version of the title; to make this property language dependent (recommended), use a key in double curly brackets: {{key}}

info

Needed for CDM (Common Data Model) conversion of tiles; to make this property language dependent (recommended), use a key in double curly brackets: {{key}}

description

Description; to make this property language dependent (recommended), use a key in double curly brackets: {{key}}

tags

Contains the following:

• An array of keywords; either text or a language-dependent entry to be specified via {{…}} syntax, for example "keywords": ["{{keyWord1}}","{{keyWord2}}"].

• An array of technicalAttributes (general technical attributes, for example, technical catalog, upper case and language-independent attributes).

ach

Application component hierarchy (SAP's component names for bug reports); attribute is mandatory for SAP apps, but is not used so far for apps developed outside SAP

dataSources

Unique key/alias for specifying the used data sources; contains the following information:

• uri: Mandatory relative URL in the component; takes embeddedBy into account, if filled, or the server absolute of the data source, for example "/sap/opu/odata/snce/PO_S_SRV;v=2/". uri should always be given in lower case.
• type: Supported types:
  • OData (default)
  • ODataAnnotation
  • INA
  • XML
  • JSON
  • FHIR
  • http
  • WebSocket
• customType (As of 1.77): true/false; if true, there is no validation on the type attribute
• settings: Data source type-specific attributes (key, value pairs), which are:
  • odataVersion: 2.0 (default), 4.0
  • localUri: Relative URL to local metadata document or annotation URI

  • annotations: Array of annotations which references an existing data source of type ODataAnnotation under sap.app/dataSources

  • maxAge: Indicates the number of seconds the client is willing to accept with regard to the age of the data that is requested

  • objects: Dictionary of (catalog) objects offered by the INA datasource (as of 1.92) consisting of:
    • objectName: Mandatory CDS view name / analytical query name
    • objectType - mandatory type of object (2C<DDICNAME> or CDSViewName); values: query, cdsprojectionview, view, inamodel
    • packageName: Name of the package
    • schemaName: Name of the schema

cdsViews

Array of directly used CDS views

This attribute is optional and only added if used via INA protocol directly, not if used via OData service.

offline

Indicates whether the app is running offline; default is false (online)

sourceTemplate

If an app has been generated from a template, this attribute is filled automatically by the generation tool:

• id: Mandatory ID of the template from which the app was generated

• version: Mandatory version of the template from which the app was generated

• toolsId: ID generated by the tool

openSourceComponents

Array of directly used open source libraries for documentation purposes; not used when open source libraries are used via SAPUI5 capsulation

• name: Mandatory name of the open source component

• version: Required if the open source component is part of the app; not required if the open source component is part of the SAPUI5 dist layer

• packagedWithMySelf: Indicates if the open source component is part of the app (true) or not (false)

provider

Name of the provider that owns the application. Current supported enum value is sfsf.

crossNavigation

Cross-navigation for specifying inbounds and outbounds

• scopes: Scope of a site

  sapSite

• inbounds: Unique key or alias to specify inbounds (mandatory); contains:

  • semanticObject (mandatory)

  • action (mandatory)

  • icon: Used to overwrite sap.ui/icons/icon

  • title: Used to overwrite sap.app/title (to make this property language dependent (recommended), use a key in double curly brackets: {{key}})

  • subTitle: Used to overwrite sap.app/subTitle (to make this property language dependent (recommended), use a key in double curly brackets: {{key}})

  • shortTitle: Used to overwrite sap.app/shortTitle (to make this property language dependent (recommended), use a key in double curly brackets: {{key}})

  • info: Additional information on the title; to make this property language dependent (recommended), use a key in double curly brackets: {{key}}

  • displayMode: <ContentMode or HeaderMode> Display mode for an inbound which specifies what kind of tile is displayed. A static tile can be displayed in content mode or header mode. The tile in header mode is a text only tile without an icon which allows longer title and subtitle.

  • hideLauncher (true/false): Indicates that an inbound must not be represented as a tile/link

  • indicatorDataSource; specifies the data source; contains:

    • dataSource: reference to sap.app/dataSources (mandatory)

    • path: Relative path to sap.app/dataSources uri (mandatory)

    • refresh: Defines the refresh interval

  • deviceTypes: Contains objects with device types on which the app is running; if empty, use the default from sap.ui/deviceTypes; the following device types can be defined (true/false):

    • desktop

    • tablet

    • phone

  • signature: Specifies the signature; contains:

    • parameters (mandatory): Contains parameter names with the following information:

      • required (true/false)

      • filter: Represents the filter only if the input parameter matches the filter; with a mandatory value and format attribute ("plain", "regexp", "reference")

      • defaultValue: Specifies the default value; has mandatory attributes value (depending on the format this is a verbatim default value) and format ("plain", "reference"). If the format is "reference", the syntax for the value is as follows: "UserDefault.parameterName" for single-value parameters, "UserDefault.extended.parameterName" for sets of values and value ranges, or "User.env.parameterName" for supported user-specific settings.

      • renameTo: Used for parameter mapping to specify the parameter name in legacy ABAP applications, for example, RF05L_BUKRS for the CompanyCode parameter

      • launcherValue: Represents a value to be used when creating an tile intent for this inbound with value and format ("plain", "array")

    • additionalParameters (mandatory): Indicates how additional parameters to the declared signature are handled; values can be, for example, "ignored", "notallowed", "allowed"

• outbounds: Specifies outbounds with a unique key or alias to describe intents that can be triggered from the application to navigate containing:

  • semanticObject (mandatory); represents a business entity (such as 'Employee')

  • action (mandatory); represents the action to perform on the business entity (such as 'display')

  • parameters of navigation intents: Specifies the parameter name

    • value: parameters of navigation intents generated or triggered by the application, with:

      • a value; verbatim value (when 'plain' format is used), or a pattern (when 'regexp' format is used), or a value coming from a UI5 model (when 'binding' format is used), or a User Default reference (when 'reference' format is used) and a

      • format; indicates how value is to be interpreted:

        • 'plain': 'value' is taken as a literal string value.
        • 'reference': 'value' is a reference to a parameter maintained in the SAP Fiori launchpad (such as 'UserDefault.CostCenter'. The parameter value is used on the outbound intent parameter.
        • 'regexp': 'value' matches the specified pattern.
        • 'binding': 'value' is a binding path. The value from the model at the specified binding path will be used on the outbound intent parameter.

    • required: Indicator whether parameter is required (true, false)

  • additionalParameters: Indicates whether additional context parameters are to be used:

    • ignored: Parameters are not used

    • allowed: Parameters are passed on to application

resources

Relative URL as a reference to a file (naming convention is resources.json) that contains a list of all resources needed by the app (all resources inside the app); the file is generated in an SAP Fiori tools (in SAP Business Application Studio) build step.

For a description of resources.json, see The resources.json File.

technology

A mandatory attribute that specifies the UI technology; value is UI5

icons

Contains object with app-specific icons, which are:

• icon: Icon of the app, can be chosen from Icon Explorer .
• favIcon: ICO file to be used inside the browser and for desktop shortcuts
  Note

  favIcon is not set automatically by the framework. The icons can be set manually using the sap/ui/util/Mobile module and the setIcons function.

• phone: 120x120 pixel version for iPhones with low pixel density
• phone@2: 180x180 pixel version for iPhones with high pixel density
• tablet: 152x152 pixel version for iPads with low pixel density
• tablet@2: 167x167 pixel version for iPads with high pixel density

deviceTypes

Mandatory; contains objects with device types on which the app is running, such as:

• desktop: Indicator for whether desktop devices are supported, true, false
• tablet: Indicator for whether tablet devices are supported, true, false
• phone: Indicator for whether phone devices are supported, true, false

fullWidth

Indicates whether SAP Fiori launchpad shall render the target application utilizing the full width of the viewport (true) or not (false). For more information, see Letterboxing.

resources

Specifies additional css and js resources of the Component.

CSS files are added to the head of the HTML page as a link tag. JavaScript files are loaded by the require mechanism.

Two settings can be defined per resource:

• uri (mandatory): URLs are resolved relative to the Component, taking the embeddedBy setting into account (if filled).

• id (optional): Only for css resources; the id for a CSS file's <link> element.

dependencies

Mandatory; specifies the external dependencies that are loaded by the SAPUI5 core during the initialization phase of the component and used afterwards. These are the following libraries or components:

• minUI5Version: Mandatory; Minimum version of SAPUI5 that your component requires; this information ensures that the features of the SAPUI5 runtime version of the component are available. This must be either a specific version or an array of versions where each major version can only be included once. If you specify an array that contains more than one version, and if version 1 is included, it must be at least 1.120.x. As SAPUI5 does not currently enforce use of the correct version, the minUI5Version is used for information purposes only. If the minimum SAPUI5 version criteria is not fulfilled, a warning is issued in the console log.

• libs: ID (namespace) of the libraries that the SAPUI5 core should load for use in the component. If your app requires a minimum version of the lib, specify the minVersion for information purposes. Specify lazy to indicate that the lib shall be lazy loaded.

• components: ID (namespace) of the components that the SAPUI5 core should load for use in your component. If your app requires a minimum version of the component, specify the minVersion for information purposes. Specify lazy to indicate that the component shall be lazy loaded.

For more information, see Descriptor Dependencies to Libraries and Components.

componentUsages

Specifies the used components with the a unique key/alias. Contains the following:

• name: Mandatory name of the reuse component

• settings: Settings of the component

• componentData: Component data of the component

• lazy: Indicates whether the component usage should be lazily loaded. Default value: true

For more information, see: Using and Nesting Components.

models

Defines models that should be created or destroyed along the component's lifecycle. The key represents the model name. Use an empty string ("") for the default model.

• type: Model class name
• uri: Relative URL in the component, taking embeddedBy into account if filled, or server for absolute model
• settings: Object that is passed to the model constructor.
  Example

  You can overwrite the default binding mode with the defaultBindingMode attribute (enumeration of type sap.ui.model.BindingMode, with values. Default, OneTime, OneWay, TwoWay). For OData models constructor see the following:

  • sap.ui.model.odata.v2.ODataModel

  • sap.ui.model.odata.v4.ODataModel

  For ResourceModel constructor see:

  • sap.ui.model.resource.ResourceModel

  The attribute enhanceWith can be specified with bundleUrl, bundleUrlRelativeTo (either component (default) or manifest) or bundleName to provide a list of additional resource bundle configurations to enhance the ResourceModel with. Additional attributes can be found in Supported Locales and Fallback Chain and Terminologies.

• dataSource: String of key or alias from sap.app dataSources to reference an existing data source; the type, uri and settings properties are set according to the data source's type, uri and settings (if not already defined). If the type under sap.app dataSources is OData, an OData Model V2 is created automatically. If you need an OData Model V1, specify the type as well.

• preload: Optional; Boolean with true, false (default)

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

  For more information, see Manifest Model Preload.

rootView

Specifies the root view that shall be opened; can be the view name as a string for XML views, or the view configuration object with viewName for the view name as a string (see sap.ui.core.mvc.View.create) and type for the type (enumeration of sap.ui.core.mvc.ViewType), id, async, and other properties of sap.ui.core.mvc.view.

autoPrefixId

true, false (default), Enables the auto prefixing for the UIComponent for 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 (for example a component's router uses this method when creating new views).

In former SAPUI5 releases this prefixing of the ID needed to be done with oComponent.createId by overwriting the method getAutoPrefixId. The same can now be achieved declaratively by setting autoPrefixId to true.

handleValidation

Possible values: true or false (default); used to enable or disable validation handling by the message manager for this component, see Error, Warning, and Info Messages

config

Static configuration; specify the name-value pairs that you need in your component.

routing

Provides configuration parameters for route and router, see Routing and Navigation

extends

Used to extend another component.

• component: ID (namespace) of the component being extended

• minVersion: Specifies the minimum version of the component being extended, for information purposes if your app requires a minimum version of the component

• extensions: Component or view extensions, which enable you to replace and extend views and controllers and also to modify the views, see Extending Apps

contentDensities

Mandatory; contains an object with the content density modes that the app supports, see Content Densities

• compact: Mandatory; indicates whether compact mode is supported (true, false)

• cozy: Mandatory; indicates whether cozy mode is supported (true, false)

resourceRoots

Map of URL locations keyed by a resource name prefix; only relative paths inside the component are allowed and no ".." characters

This attribute is intended for actual sub-packages of the component only, meaning that it must not be used for the component namespace itself.

componentName

An optional attribute that only has to be provided if your project is a variant of an existing application. In this case the componentName has to contain the sap.app/id of the existing application which is the basis of your variant.

library/i18n

Determines whether the library contains an i18n resource. The value can be either a boolean, a string, or an object.

A string value represents a bundle URL. Relative URLs are always resolved to the library origin. If no value is set, the default messagebundle.properties file is loaded.

An object value can contain additional resource bundle configuration, e.g. terminologies and supported locales. For the supported features and for sample definitions, see the respective entries at Terminologies (without bundleUrlRelativeTo) and Supported Locales and Fallback Chain .

flexEnabled

Indicates whether the app is enabled for adaptation via SAPUI5 flexibility (for example, using stable IDs); possible values are true, false or undefined (default)

For more information, see SAPUI5 Flexibility: Enable Your App for UI Adaptation.

commands

Specifies provided commands with a unique key/alias. Contains:

• shortcut: String that describes a key combination. When the user presses the key combination, the command is triggered.

The name of the command that contains the shortcut definition acts as a prerequisite for using the command property of the sap.ui.core.CommandExecution module. For more information, see the API Reference: sap.ui.core.CommandExecution.

flexExtensionPointEnabled

Indicates whether SAPUI5 flexibility extension points are enabled for the corresponding application variant; possible values are: true, false; filled automatically during app variant merge.

uri

Specifies the app's URI in the ABAP system, for example /sap/bc/ui5_ui5/sap/appName; filled during deployment.

uri

Specifies the URI inside the SAP Business Technology Platform HTML5 application; filled during deployment, default is ""

providerAccount

Specifies the name of the provider account; filled during deployment

appName

Specifies the name of the deployed HTML5 application; filled during deployment

appVersion

Specifies the version of the deployed HTML5 application; filled during deployment

registrationIds

Array of registration IDs, for example, the SAP Fiori IDs for SAP Fiori apps

archeType

Mandatory archetype of the app, possible values transactional, analytical, factsheet, reusecomponent, fpmwebdynpro, designstudio

abstract

Indicates whether an app is an abstract (generic) app, which may not used directly, but needs to be specialized in the SAP Fiori launchpad content (as of 1.87). Please note: This attribute will not be inherited by app variants, for example, based on an adaptation project.

cloudDevAdaptationStatus

Release status for the developer adaptation in the cloud. The supported types are released, deprecated, obsolete, no value means not released (as of 1.110.0).

type

Describes the card type; possible values are list and analytical

header

Specifies the card's header area

content

Specifies the type-dependent card content