Création et ajout d’un point d’extension d’interface utilisateur

Lors du développement d’une application, créez des points d’extension d’interface utilisateur et ajoutez-les aux macros d’interface utilisateur côté serveur, telles que les extensions HTML ou les pages de l’interface utilisateur dans le code de l’application de base.

Utilisez un point d’extension d’interface utilisateur pour désigner l’emplacement spécifique où les données ou les objets peuvent être envoyés à une macro d’interface utilisateur personnalisée enregistrée et où les résultats renvoyés sont traités.

Créer un point d’extension d’interface utilisateur

Créez un point d’extension d’interface utilisateur que vous pouvez placer dans les macros d’interface utilisateur, telles que les extensions HTML, dans le code d’application. En plaçant le point d’extension d’interface utilisateur, vous désignez l’emplacement spécifique dans le code d’application où les données ou les objets peuvent être envoyés à une personnalisation et où les données sont renvoyées.

Avant de commencer

Rôle requis : admin ou rôle spécifique du développeur ou de l’administrateur de l’application

Remarque :

Pour en savoir plus sur les rôles d’administrateur spécifiques aux applications et le développement délégué, consultez Règles de contrôle d’accès dans les applications d’administration d’application et Développement et déploiement délégués.

Pourquoi et quand exécuter cette tâche

Définir Contenu et structure d’un point d’extension. Cette définition doit décrire la façon dont une personnalisation doit être structurée, comment elle interagit avec le code d’application et comment les données renvoyées par une personnalisation au point d’extension sont traitées.

En créant une définition correcte, vous structurez la fonctionnalité des extensions.

Procédure

1. Accédez à la Tout > Points d'extension système > Points d'extension d'interface utilisateur.
2. Cliquez sur Nouveau.
3. Renseignez les champs du formulaire.

   Tableau 1. Formulaire de point d’extension de l’interface utilisateur

   Champ	Description
   Nom	Nom unique pour le point d’extension. Le nom peut comporter jusqu’à 100 caractères alphanumériques, y compris les caractères spéciaux.
   Nom de l'API	Nom de l’API de point d’extension qui est ajoutée au périmètre de l’application auquel elle s’applique. Il s’agit d’un nom affecté par le système qui ne peut pas être modifié.
   Demande	Périmètre de l’application par rapport auquel le point d’extension est affecté. Il s’agit d’une affectation du système et ne peut pas être modifiée. Pour plus d’informations sur les protections offertes par l’utilisation de la définition du champ d’application, reportez-vous à la section Application scope.
   Limiter à ce périmètre	Option permettant de limiter le point d’extension au périmètre de l’application uniquement.
   Autoriser l'accès sur AJAX/REST	Option permettant d’activer ou de désactiver l’accès au point d’extension d’interface utilisateur sur AJAX ou REST. Pour en savoir plus sur ces architectures et techniques de développement, reportez-vous à la section AJAX et REST APIs.
   Description	Les exigences relatives au script personnalisé Macro d’interface utilisateur, telles que la façon dont le script d’interface utilisateur doit être structuré et comment il doit fonctionner avec le code d’application.
   Exemple	Exemple de la façon dont une macro d’interface utilisateur personnalisée qui interagit avec ce point d’extension doit être structuré de sorte qu’il fonctionne avec le code d’application.

4. Cliquez sur Envoyer.

Ajouter un point d’extension d’interface utilisateur dans le code d’application de base

Ajoutez le point d’extension d’interface utilisateur dans une macro d’interface utilisateur ou une extension HTML dans le code d’application de base. Pour ajouter le point d’extension, placez un appel d’API qui identifie l’emplacement où les artefacts personnalisés enregistrés s’exécutent.

Avant de commencer

Rôle requis : admin ou rôle spécifique du développeur ou de l’administrateur de l’application

Vous devez d’abord créer un point d’extension d’interface utilisateur avant de pouvoir l’ajouter à une macro d’interface utilisateur ou à une page d’interface utilisateur dans le code d’application.

Remarque :

Pour en savoir plus sur les rôles d’administrateur spécifiques aux applications et le développement délégué, consultez Règles de contrôle d’accès dans les applications d’administration d’application et Développement et déploiement délégués.

Procédure

1. Dans le code d’application, accédez à la macro d’interface utilisateur existante à laquelle vous souhaitez ajouter un point d’extension scripté ou créez-en un nouveau.
   Pour en savoir plus sur la création de macros d’interface utilisateur à l’aide de balises jelly, reportez-vous aux sections Macros d'interface utilisateur et Balises Jelly.
2. Dans la macro d’interface utilisateur, ajoutez une balise Jelly avec une ligne de code à l’emplacement prévu pour collecter et traiter la sortie de macro d’interface utilisateur personnalisée.
   En règle générale, cette ligne de code contient :

   • Commande call_extension qui identifie le nom du point d’extension de l’interface utilisateur (par exemple, extension="global). KMArticle.ViewHeader") par rapport auquel les macros d’interface utilisateur personnalisées sont enregistrées.
   • Arguments qui sont transmis dans la macro d’interface utilisateur lorsqu’elle est rendue. Par exemple, pour un Base de connaissances article, knowledgerecord="${knowledgeRecord} » transmet l’enregistrement actuel de la base de connaissances.
   • (Facultatif) S’il existe plusieurs implémentations de ce point d’extension, l’utilisation d’une commande limit spécifie qu’un nombre x d’implémentations doit être renvoyé (par exemple, limit="1 »). Cette figure montre une macro d’interface utilisateur qui contient ces commandes.