Card Manifest
The card manifest is JSON file that describes the card.
It is based on the namespaces definitions in the UI5 Descriptor for Applications, Components and Libraries.
Additionally, Integration cards extend this structure by adding the "sap.card" namespace.
There are several namespaces that are essential for Integration cards:
"sap.card" Namespace
"sap.card" is the main namespace to be used when defining Integration cards. It has the following attributes (properties):
| Property | Type | Default Value | Required | Description | Schema Version | Since |
|---|---|---|---|---|---|---|
| type | string | Yes |
The type of the card.
One of:
|
1.14.0 | 1.62 | |
| header | object | Yes | One of Header or NumericHeader. | 1.14.0 | 1.62 | |
| content | object | Yes | The content of the card. Based on the "type" property it has different structure. See: | 1.14.0 | 1.62 | |
| footer | Footer | No | The footer of the card. | 1.35.0 | 1.93 | |
| configuration | Configuration | No | General configuration of the card. Allows to define parameters, destinations, filters and more. | 1.15.0 | 1.65 | |
| extension | string | No | Path to extension module. | 1.23.0 | 1.79 | |
| data | Data | No | Data definition for the card. | 1.15.0 | 1.65 | |
| requiredHeight | string | No | Card minimum required height. | 1.37.0 | 1.96 | |
| requiredWidth | string | No | Card minimum required width. | 1.37.0 | 1.96 |
"sap.app" Namespace
Besides the "sap.card" namespace, every card manifest should also provide the mandatory fields of the "sap.app" namespace, such as "id" and "type": "card".
Find the full list of the properties in the sap.app section in the UI5 Descriptor for Applications, Components and Libraries.
"sap.ui5" Namespace
This namespace is used when the type of the card is "Component" or when there are dependencies to be preloaded for Extension. Find the full list of the properties in the sap.ui5 section in the UI5 Descriptor for Applications, Components and Libraries.