Modules d'extension de l'API › Création et utilisation de modules d'extension de l'API

Création et utilisation de modules d'extension de l'API

Pour créer et utiliser un module d'extension de l'API, suivez le processus suivant :

1. Définissez le but du module d'extension ; par exemple, pour remplir un champ de sélection avec des salles de réunion qu'un utilisateur peut réserver pour une période spécifique. Les options de salle de réunion incluent également des projecteurs, des unités de vidéoconférence, des microphones, etc.
2. Vous devez remplir les conditions préalables et être en mesure d'effectuer les actions suivantes de manière efficace :
   • Programme Java
   • Création de formulaires à l'aide du concepteur de formulaires
   • Dans les formulaires du concepteur de formulaires, créez les champs suivants :
     • Des champs à sélection unique, à sélection multiple et de listes doubles
     • Champs de tables dynamiques
3. Consultez la Documentation du module d'extension de l'API, comme suit :
   1. Connectez-vous à CA Service Catalog et sélectionnez l'Administration, Outils.
   2. Dans le menu de gauche, sélectionnez Liens.
   3. Faites défilez le document jusqu'à la section Documentation et cliquez sur Documentation du module d'extension.

   La documentation relative à l'API est une documentation Java générée automatiquement d'après les méthodes de classe Java pour les modules d'extension. Vous pouvez utiliser les interfaces, les classes, les méthodes, etc., pour implémenter votre module d'extension.

4. Vous pouvez créer une classe Java pour le type de champ du concepteur de formulaires auquel le module d'extension sera appliqué, de la manière suivante :
   • Pour les champs à sélection unique, à sélection multiple et de listes doubles : créez une classe Java pour implémenter l'interface appelée com.ca.usm.plugins.apis.forms.FDSelectDataProvider.
   • Pour des champs de tables dynamiques : créez une classe Java pour implémenter l'interface appelée com.ca.usm.plugins.apis.forms.FDTableDataProvider.

   Les interfaces comme les exemples de classes Java s'affichent dans la documentation du module d'extension de l'API. Vous pouvez utiliser ces exemples figurant dans la documentation du module d'extension de l'API comme modèles pour vos classes Java.

5. (Facultatif) Si vous utilisez des formulaires de configuration de contenu, récupérez des valeurs des champs qu'ils contiennent et utilisez-les si nécessaire.
6. Créez un fichier de propriétés pour le module d'extension. Vous pouvez utiliser ces exemples figurant dans la documentation du module d'extension de l'API comme modèles pour vos fichiers de propriétés.
7. Le cas échéant, vous pouvez effectuer l'une des opérations suivantes :
   • Configuration des paramètres de tri et de pagination des tables statiques
   • Configuration des paramètres de tri et de pagination des tables dynamiques
   • Configuration de l'attribut de Taille de page pour la configurer de la pagination d'une boîte de sélection
8. Créez un dossier pour stocker les éléments suivants :
   • Fichier de propriétés

     Important : Stockez le fichier de propriétés au niveau supérieur du dossier. Ne le stockez pas dans un sous-dossier.

   • Tout fichier .jar contenant les classes et les bibliothèques de soutien

     Vous pouvez les stocker dans des sous-dossiers, si nécessaire.

9. Pour activer le module d'extension procédez comme suit :
   1. Arrêtez le service Windows pour Service View, appelé CA Service View.
   2. Copiez votre dossier (y compris tous les sous-dossiers, le cas échéant) vers le dossier %USM_HOME%\filestore\plug-in.
   3. Redémarrez le service Windows pour Service View.
10. Pour vérifier que le module d'extension a été adopté, Procédez comme suit :
    1. Connectez-vous à CA Service Catalog et sélectionnez l'Administration, Outils.
    2. Dans le menu de gauche, sélectionnez Modules d'extension.
    3. Vérifiez que le module d'extension est répertorié et que ses détails s'affichent correctement.

Vous pouvez maintenant tester cet API pour l'utilisation dans un champ de formulaire.