UI Integration Cards
Les UI integration cards sont des cards SAPUI5 définies de manière déclarative dans un fichier manifest.json qui décrit l'en-tête, le contenu, la source de données et les actions, afin qu'un hôte comme SAP Build Work Zone ou My Home puisse les afficher sans application complète. Les UI integration cards présentent un contenu concis et actionnable, avec un lien vers l'application sous-jacente.
L'essentiel
- Type
- Widget d'interface défini par manifest (sap.ui.integration.widgets.Card)
- Couche
- Point d'entrée et expérience, construit comme contenu d'interface
- Types de cards
- List, Table, Object, Analytical, Timeline, Calendar ; Component ; WebPage ; Adaptive
- Hôtes
- SAP Build Work Zone, My Home, Joule, SAP Mobile Start
- Construit avec
- SAP Business Application Studio (template UI Integration Card), Card Explorer
- Qui l'utilise
- Développeurs SAP Fiori et SAP BTP, administrateurs de site
- S'applique à
- SAP BTP ; SAP S/4HANA via My Home (toutes les options de déploiement)
Couche : Point d'entrée et expérienceOù se situe-t-il ? ▾
Couche : Point d'entrée et expérience
Concerne aussi : Applications d'interface
Ouvrir la carte d'architecture →Comment fonctionne une UI integration card ?
Une UI integration card sépare ce que la card affiche de l'endroit où elle s'affiche :
- Le développeur de la card écrit un manifest.json avec une section
sap.cardqui définit le type de card, l'en-tête (titre, sous-titre, icône, statut ou KPI numérique), le contenu, la requête de données et les actions, comme la navigation vers une application. - L'hôte, par exemple un site SAP Build Work Zone, intègre la card, décide de sa taille et de sa position, et résout la connectivité, généralement via des destinations configurées côté hôte.
- À l'exécution, le contrôle de card SAPUI5 lit le manifest, charge les données et affiche un conteneur doté d'une zone d'en-tête et d'une zone de contenu.
La définition étant déclarative, la même card peut être réutilisée dans plusieurs hôtes. Le site achats d'Alder Manufacturing pourrait afficher une list card des livraisons de Bright Freight en retard, qui ouvre l'application complète. Une UI integration card est donc un élément de contenu portable, et non une application à part entière.
Quels types d'UI integration cards existent ?
| Type de card | Définition | Usage typique |
|---|---|---|
| Déclaratives : List, Table, Object, Analytical, Timeline, Calendar | Entièrement configurées dans le manifest | La plupart des cards métier : listes, KPI, graphiques, un objet |
| Component card | Intègre un petit composant SAPUI5 doté de son propre code | Interactions que les types déclaratifs ne peuvent pas exprimer |
| WebPage card | Affiche une page web externe | Intégration de contenu non SAPUI5 |
| Adaptive card | Affiche le format ouvert Adaptive Card | Réutilisation d'Adaptive Cards existantes ; SAP recommande plutôt les types déclaratifs |
Les cards déclaratives peuvent malgré tout exécuter une logique spécifique au moyen d'extensions JavaScript. La comparaison de SAP souligne aussi que ces cards diffèrent du contrôle freestyle sap.f.Card et des cards d'overview page, qui relèvent de SAP Fiori elements. Choisir en priorité une UI integration card déclarative permet de garder une card portable entre hôtes et éditions.
Où utiliser les UI integration cards ?
- SAP Build Work Zone : les deux éditions exécutent des cards sur les pages de site. Les cards déclaratives sont entièrement prises en charge dans les éditions standard et advanced ; certaines fonctions des component cards ne fonctionnent que dans l'édition advanced. Dans l'édition standard, une card parvient aux utilisateurs via un content package.
- My Home dans SAP S/4HANA : les utilisateurs peuvent créer des insights cards à partir de tableaux de list report et de graphiques d'analytical list page dans les applications SAP Fiori elements, une fois qu'un administrateur a activé My Home ; SAP documente les cards créées à partir d'un tableau de list report comme des integration cards. Cela s'applique à SAP S/4HANA Cloud Public Edition et à SAP S/4HANA, où My Home est disponible à partir de la release 2023 FPS01.
- Joule et mobile : Joule peut renvoyer des manifests de cards dans ses réponses, et SAP cite SAP Mobile Start parmi les consommateurs de cards. L'application mobile Joule Work filtre les component cards.
- Autres solutions SAP : par exemple, SAP SuccessFactors prend en charge des UI integration cards personnalisées dans certaines zones du profil.
L'endroit où une UI integration card peut apparaître dépend de l'hôte, de son édition et du type de card, pas de la card seule.
Pourquoi une UI integration card ne s'affiche-t-elle pas ?
- Fonctions de component card dans l'édition standard. SAP indique qu'une card utilisant une fonction réservée à SAP Build Work Zone, advanced edition apparaît dans la galerie de contenu et l'éditeur de pages, mais échoue à l'exécution dans l'édition standard. Consultez le tableau des fonctions prises en charge pour l'édition cible.
- Filtrage mobile. Les component cards ne s'affichent pas dans l'application mobile Joule Work. Utilisez une card déclarative si le mobile compte.
- Destination manquante. Les requêtes de données sont résolues via l'hôte. Une destination absente du sous-compte laisse la card vide ou en erreur.
- Absente d'un content package. Dans l'édition standard, SAP exige qu'une card déployée soit ajoutée à un content package avant de pouvoir être utilisée sur un site.
- Limites de l'éditeur. SAP précise que l'éditeur de cards UI de Work Zone ne prend en charge les fonctions de card que jusqu'à une version SAPUI5 donnée ; consultez la documentation de Work Zone pour connaître la version actuelle.
La plupart des défaillances d'UI integration cards relèvent de la configuration de l'hôte plutôt que d'erreurs dans le manifest de la card.
UI integration card, card d'overview page ou tile : quelle différence ?
| UI integration card | Card d'overview page | Tile | |
|---|---|---|---|
| Définition | Card définie par manifest, indépendante de l'hôte | Card intégrée à une overview page SAP Fiori elements | Entrée du launchpad qui lance une application |
| Défini par | manifest.json de la card (sap.card) | App descriptor de l'overview page et annotations OData | Technical catalog, avec un target mapping |
| Où il apparaît | SAP Build Work Zone, My Home, Joule et autres hôtes | Uniquement dans son application overview page | Pages du SAP Fiori Launchpad et sites Work Zone |
| Contenu | Listes, tableaux, graphiques, détails d'objet, actions | Listes, tableaux et graphiques issus de services OData | Titre, icône et éventuellement un nombre |
Une UI integration card est un contenu portable pour de nombreux hôtes, une card d'overview page vit dans une seule application SAP Fiori elements, et une tile ne fait que lancer une application.
Questions fréquentes
Les UI integration cards sont-elles la même chose que les cards d'overview page ?
Non. SAP indique explicitement que les UI integration cards n'ont aucun lien avec les cards de l'overview page SAP Fiori elements. Les cards d'overview page sont configurées au sein d'une application overview page, tandis que les UI integration cards sont définies par leur propre manifest et peuvent être intégrées dans différents hôtes.
Les UI integration cards nécessitent-elles SAP Build Work Zone ?
Non. SAP Build Work Zone est l'hôte le plus courant, mais les UI integration cards apparaissent aussi dans My Home dans SAP S/4HANA, dans les réponses de Joule, dans SAP Mobile Start et dans d'autres solutions SAP. Toute application SAPUI5 peut également intégrer une card.
Comment créer une UI integration card ?
Dans SAP Business Application Studio, un dev space doté de l'extension Development Tools for SAP Build Work Zone propose un template de projet UI Integration Card. Le développeur modifie le manifest, le prévisualise, puis déploie la card dans SAP Build Work Zone ou la télécharge sous forme de fichier ZIP.
Faut-il utiliser une card déclarative ou une component card ?
Commencez par une card déclarative. Les types déclaratifs couvrent les listes, les tableaux, les objets et les graphiques, fonctionnent dans les deux éditions de SAP Build Work Zone et sur mobile, et autorisent les extensions JavaScript. Ne choisissez une component card que pour une interaction que les types déclaratifs ne peuvent pas exprimer, et vérifiez d'abord la prise en charge par l'édition.
Sources
- SAP Help Portal: Cards — integration cards vs. freestyle cards (SAPUI5)
- SAP Help Portal: Developing UI Integration Cards (SAP Build Work Zone, standard edition)
- SAP Help Portal: Supported Declarative and Component Card Features (SAP Build Work Zone)
- SAP Help Portal: Creating Cards for the Insights Cards Section of My Home (SAP Fiori elements for OData V4)
- SAPUI5 SDK: Card Explorer (UI integration cards)
- S'applique à
- SAP S/4HANA on-premise · SAP S/4HANA Cloud Private Edition · SAP S/4HANA Cloud Public Edition · SAP BTP
- Dernière relecture