Comprendre les indications uiHint

Un schéma peut être utilisé pour décrire la structure d'un objet métier ou de tout autre document XML. Le cas échéant, le même schéma peut également intégrer des indications d'interface (uiHints) qui sont interprétées lors de l'exécution et qui affichent le code HTML nécessaire pour afficher ou tenir à jour ce document. Pour plus d'informations, voir Syntaxe des indications uiHint.

Les principaux avantages de cette technique sont les suivants :
  • Moins sujet aux erreurs. Une corrélation plus étroite entre la structure des données et sa couche de présentation permet de maintenir cette dernière à jour, par exemple :
    • L'ajout ou la suppression d'un élément au schéma entraîne une modification correspondante de la couche de présentation. Notez que vous pouvez exclure explicitement des éléments de la couche de présentation selon vos besoins.
    • Le widget HTML le plus approprié pour présenter ou saisir des données pour un élément est déterminé par son type de données, défini par le schéma. Par exemple, un sélecteur de date est utilisé pour un élément d'entrée de date. Si le type de données de l'élément change dans le schéma, sa présentation s'ajuste en conséquence.
  • Plus rapide à mettre en œuvre. Aucune compétence HTML n'est nécessaire. La définition de schéma ainsi que les indications uiHint intégrées sont utilisées pour afficher le code HTML lors de l'exécution. Éliminer le besoin de créer du code HTML et de le tenir à jour dans une matrice IU réduit les coûts d'implémentation et de maintenance.
  • Prend en charge l'héritage d'objet métier. L'intégration de la couche de présentation dans le schéma d'objet métier permet à chaque objet métier d'une hiérarchie de contribuer à l'ensemble du code HTML qui affiche l'entité. En d'autres termes, le code HTML complet utilisé pour afficher un objet métier sous-classé est constitué du code HTML affiché par le schéma inclus de son objet métier parent, suivi des éléments étendus par la sous-classe.

Cette section décrit les concepts et fournit des conseils relatifs à la fonctionnalité d'indications uiHint.

Modes d'affichage ou d'entrée

Le même schéma peut être utilisé pour générer une version d'affichage de sa matrice HTML ou une matrice d'entrée. Dans la version d'affichage, les valeurs d'élément sont présentées en lecture seule, les descriptions correspondantes sont affichées à la place des codes et d'autres artefacts tels que les liens sont disponibles pour la navigation vers les pages associées. Dans la version d'entrée, l'élément peut être modifié à l'aide du widget HTML approprié à son type de données. Par exemple, un élément de clé étrangère est affiché avec les composants de recherche et un élément de date comprend un widget sélecteur de date.

Le type de matrice générée dépend du contexte dans lequel elle est utilisée :

Par défaut, chaque élément du schéma est supposé être inclus dans les matrices de présentation d'affichage et d'entrée. Les indications uiHint permettent d'exclure un élément de la présentation, de l'inclure uniquement dans la matrice d'affichage ou de l'inclure uniquement dans la matrice d'entrée.

Pas seulement des schémas d'objet métier

Bien qu'elles soient principalement utilisées pour décrire les matrices d'affichage et de maintenance des objets métier, les indications uiHint peuvent également être intégrées dans d'autres objets basés sur un schéma :
  • Vous pouvez utiliser une zone de données pour décrire un formulaire de saisie et inviter l'utilisateur à le remplir dans une étape de script APT ou un panneau de flux de processus.
  • Vous pouvez intégrer des indications uiHint dans un schéma de script de service ou de service fonctionnel en vue d'afficher le contenu préparé par le service dans une zone de portail. Pour plus d'informations, voir Zones de matrice.
  • Vous pouvez intégrer des indications uiHint dans le schéma d'un script de service pour inviter l'utilisateur à saisir des informations avant d'appeler le script pour effectuer une tâche et présenter les résultats. Pour plus d'informations, voir Instructions de génération de matrices d'édition.

L'ordre de définition est l'ordre de présentation

Les éléments sont présentés dans l'ordre dans lequel ils sont définis dans le schéma développé. Par exemple, un objet métier de sous-classe qui inclut son objet métier parent suivi d'éléments d'extension est présenté avec la partie parent du code HTML, suivie des champs d'extension.

Utiliser des fragments de matrice IU pour le HTML complexe

Les éléments suivants décrivent les fonctionnalités de base prises en charge par la fonctionnalité d'indications uiHint :
  • Contrôlez les éléments présentés dans les matrices d'affichage et d'entrée.
  • Indiquer un titre pour la matrice d'entrée.
  • Introduire des sections autour des éléments en injectant des instructions de début et de fin de section. L'ordre dans lequel les éléments sont définis dans une section est également leur ordre de présentation.
  • Les règles de visibilité de base sont prises en charge au niveau élément et section.
Pour des exigences plus complexes concernant un élément spécifique, vous pouvez créer le code HTML/JavaScript nécessaire pour l'élément, le capturer en tant que fragment de matrice IU, intégrer le fragment dans le schéma dans l'ordre de présentation approprié et supprimer l'élément de l'affichage de base pour la matrice d'entrée ou d'affichage correspondante.
Remarque :
Vous pouvez également utiliser cette technique pour afficher des éléments à un autre emplacement de présentation. Par exemple, lorsque le script d'affichage d'un objet métier doit afficher des éléments supplémentaires qui ne font pas partie du schéma de l'objet métier. Dans ce cas, le schéma du script présente les éléments comme supprimés et le schéma de l'objet métier inclut un fragment de matrice IU HTML incorporé pour les afficher dans la section appropriée. Notez que cela ne peut fonctionner que lorsque l'objet métier et le script sont détenus par votre organisation.

Pour plus d'informations, voir Syntaxe des indications uiHint.