Applications OpenAPI

Les applications OpenAPI utilisent la flexibilité des requêtes OpenAPI pour fournir et présenter les données de manière hautement personnalisable. Les applications OpenAPI permettent d'afficher le contenu personnalisé dans les vues d'application OpenAPI au niveau des tableaux de bord et des pages de contexte. Vous pouvez créer vos propres applications ou sélectionner parmi diverses applications disponibles. Vous pouvez ensuite déployer et afficher ces applications dans npc.
capm360
HID_OpenAPI_Applications
Les applications OpenAPI utilisent la flexibilité des requêtes OpenAPI pour fournir et présenter les données de manière hautement personnalisable. Les applications OpenAPI permettent d'afficher le contenu personnalisé dans les vues d'application OpenAPI au niveau des tableaux de bord et des pages de contexte. Vous pouvez créer vos propres applications ou sélectionner parmi diverses applications disponibles. Vous pouvez ensuite déployer et afficher ces applications dans
NetOps Portal
.
La vidéo ci-dessous présente la procédure à suivre pour télécharger, déployer et ajouter des applications OpenAPI à
NetOps Portal
:

Développement des applications OpenAPI
Les applications OpenAPI sont constituées de fichiers HTML, JavaScript, CSS et de métadonnées contenus dans un fichier .zip. En règle générale, les applications utilisent les services Web
NetOps Portal
et OpenAPI.
Les directives suivantes vous guident dans le processus de développement et de test des applications OpenAPI :
  1. Le cas échéant, recherchez une application OpenAPI similaire à utiliser comme modèle pour votre nouvelle application.
  2. Configurez un dossier local pour héberger les fichiers de l'application. Utilisez un répertoire unique qui contient tous les répertoires et les fichiers requis pour l'application.
  3. Créez le fichier appConfig.properties. Ce fichier de propriétés est requis pour le déploiement dans CA
    NetOps Portal
    et pour la vue d'application. Pour des informations sur le contenu de ce fichier, consultez la documentation suivante.
    Le fichier appConfig.properties doit résider dans le répertoire de niveau supérieur unique référencé dans l'étape précédente.
  4. Utilisez le générateur de requêtes OpenAPI pour créer des exemples de requêtes odata pour votre application. Enregistrez le résultat de ces requêtes en tant que fichier statique. Commencez à développer votre code avec les données statiques.
    Après le développement, les données statiques sont utiles pour le débogage pour vous assurer que votre code d’analyse fonctionne correctement.
  5. Créez une page de démonstration. Assurez-vous que la page peut charger les données statiques. En outre, assurez-vous qu’elle peut enregistrer les données dans une variable associée à l’objet de fenêtre. Pour activer les outils de débogage de navigateur, ajoutez l’instruction debugger dans le code JavaScript.
    La page de démonstration vous permet d’utiliser un outil de débogage de navigateur. Utilisez cet outil pour consulter les données reçues et vérifiez que cette partie de l’application a fonctionné.
  6. Démarrez l’analyse des paramètres.
    Incluez l’URL que vous avez utilisée pour obtenir les données d’origine et utilisez un paramètre pour basculer en mode de débogage. Utilisez les paramètres de l’URL pour la génération de requête OpenAPI. Utilisez la fonction console.log pour connecter n’importe quelle URL à la console, par exemple console.log("url:" + url).
  7. Sélectionnez les bibliothèques JavaScript à utiliser pour l'application.
    Examinez les applications existantes pour obtenir des exemples et copiez les bibliothèques dans votre dossier d’application. Supprimez les fichiers inutiles.
  8. Démarrez l’écriture de l’application.
    • Si les données incluent plusieurs éléments, commencez avec un élément.
    • A ce stade, ne vous concentrez pas sur l’apparence de l’application. Toutefois,
      incluez
      des classes CSS dans la page HTML pour faciliter le développement.
    • Placez toutes les étiquettes à un endroit unique de votre code, si vous traduisez l’application.
  9. Lorsque l'application fonctionne, déployez-la sur votre système de test
    NetOps Portal
    . Vérifiez qu’elle fonctionne sur un serveur distant. Si vous mettez à jour votre code pour un fonctionnement à distance, il y a moins de code à retoucher à ce stade.
  10. Compressez le dossier de l’application, y compris le fichier de propriétés et déployez l’application via l’interface utilisateur.
  11. Pour tester l’application dans l’interface utilisateur, créez un tableau de bord et ajoutez les deux vues d’application.
    Modifiez l'une des vues d’application et sélectionnez votre application dans la liste déroulante. Si l’application n’apparaît pas dans cette liste, une erreur s'est glissée dans le fichier appConfig.properties.
    Une fois l'application affichée dans la première vue, modifiez l'autre vue d'application et ajoutez la même application. Ce test garantit que l'application peut prendre en charge plusieurs instances sur une seule page.
  12. Continuez à travailler localement et redéployez régulièrement l’application vers le système de test.
    Si vous mettez à jour l’URL dans les métadonnées, modifiez la vue d’application. Resélectionnez l’application pour obtenir l’URL mise à jour.
  13. Utilisez un compte d’utilisateur plus restreint sur Performance Center pour vérifier que l’application fonctionne toujours correctement.
    Si votre application prend en charge le contexte ou la plage horaire, modifiez les contrôles associés et vérifiez qu'elle répond correctement.
  14. Le cas échéant, utilisez le redirecteur pour ajouter des liens de page de contexte à votre application. Le redirecteur donne l'impression que l’application fait partie du système de manière native.
  15. Lorsque l’application est terminée, pensez à la partager avec d'autres utilisateurs sur GitHub.
    Avant d’ajouter l’application à ce référentiel, supprimez toutes les informations personnelles.
appConfig.properties
Utilisez le format suivant pour le fichier appConfig.properties :
appName=
App Name
description=
Optional app description
url=
Required_URL_parameters
height=
height in pixels
supportedContext=
context_code
  • appName
    Nom unique de l'application
  • (Facultatif)
    description
    Description qui s’affiche dans la vue d’application lorsque vous sélectionnez l’application.
  • URL
    URL de l’application et paramètres d’URL
    Pour plus d'informations sur les paramètres d'URL dans
    NetOps Portal
    , consultez la section Vues de navigateur.
  • (Facultatif)
    height
    Hauteur de la vue d'application, en pixels.
    Valeur par défaut :
    250
  • (Facultatif)
    supportedContext
    Contexte dans lequel l’application s’affiche dans la vue d’application. Vous pouvez utiliser ce paramètre pour limiter les applications disponibles à des contextes spécifiques. Par exemple, si vous spécifiez la seule valeur
    i
    , l’application est disponible uniquement dans les vues d’application sur les pages de contexte d’interface et n’est pas disponible au niveau du tableau de bord.
    Valeurs :
    • d
      Unité
    • i
      Interface
    • s
      Serveur
    • r
      Routeur
    • g
      Groupe
    • nc
      Aucun, s’affiche dans tous les contextes
    Valeur par défaut :
    nc
    Pour désigner plusieurs contextes, séparez les valeurs par une virgule.
Exemple :
appName=Percentile Trend App description=This is a Percentile Trend App url=index.html?id={ItemIdDA}&startTime={TimeStartUTC}&endTime={TimeEndUTC}&metric=im_UtilizationIn height=750
supportedContext=i,d
Meilleures pratiques de développement d’applications
Utilisez les meilleures pratiques suivantes pour le développement d’applications OpenAPI :
  • N’utilisez pas les bibliothèques JavaScript avec source en externe. Si vous avez besoin de bibliothèques pour votre application, incluez la bibliothèque dans son dossier. Incluez également tous les fichiers qui décrivent les conditions de licence de la bibliothèque.
  • N'utilisez pas les fichiers JavaScript, CSS ni les images fournis dans
    NetOps Portal
    . Lorsque ces entités sont mises à jour, cette application peut s'endommager.
  • Testez l’application pour vérifier qu’elle fonctionne selon l’échelle et les différentes configurations. De nombreuses applications dépendent des ressources système, comme les services Web. Vérifiez que l’application ne génère aucune charge inutile.
  • Créez des modes de test dans l’application pour déboguer les problèmes. Ajoutez un paramètre facultatif qui bascule de l'utilisation d’une API de service Web à un ensemble prêts à l’emploi de données incluses dans l’application.
  • Si vous distribuez l’application à d’autres utilisateurs, vérifiez qu’aucune information privée n'est incluse. Nettoyez les fichiers de données statiques inclus pour le débogage.
  • Utilisez les chemins d’accès relatifs et n'incluez jamais l’URL complète. Si le système se trouve derrière un pare-feu ou change les noms DNS, l'utilisation d'URL complètes endommage l'application. L'utilisation de chemins d'accès relatifs facilite la transition entre la phase de développement en local et la phase de déploiement de l'application.
  • Vérifiez que l’application fonctionne dans un iframe. La vue de navigateur et la vue d’application utilisent des iframes pour isoler les applications du reste de la page.
  • OpenAPI utilise les ID d’éléments Data Aggregator. Les ID
    NetOps Portal
    ne sont pas reconnus. Utilisez les services Web de sources de données pour la conversion entre l'ID d'élément Data Aggregator et l'ID
    NetOps Portal
    . Pour plus d'informations, consultez la rubrique Service Web Sources de données.
  • Pour accéder aux données OpenAPI, la demande doit provenir d'une application présente sur l'hôte
    NetOps Portal
    . Le déploiement de l'application place le dossier d'application sur l'hôte
    NetOps Portal
    .
  • Pour les requêtes oData directes des applications, utilisez le chemin d'accès relatif pour le système
    NetOps Portal
    pour utiliser le proxy OpenAPI :
    /pc/odata/api/...
Téléchargement d'une application
Plusieurs applications sont disponibles sur GitHub. Ces applications sont prises en charge via la collaboration open source avec GitHub :
Copyright (c) 2018 CA Technologies
The MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Procédez comme suit :
  1. Accédez à https://github.com/CA-PM.
    Une liste des applications disponibles et leur description s’affichent.
  2. Cliquez sur l’application que vous souhaitez.
    Le contenu de l’application, un exemple de visualisation et des instructions de fichier Readme s’affichent.
  3. Cliquez sur
    Clone or download
    (Cloner ou télécharger) et
    Download ZIP
    (Télécharger le fichier .zip).
  4. Enregistrez les fichiers vers le répertoire de votre choix.
Déploiement d'une application
Pour déployer les applications OpenAPI, chargez l'application via
NetOps Portal
. Vous pouvez déployer des applications lors de l'exécution du système. Le déploiement d'applications ne requiert pas de redémarrage. Pour un déploiement réussi, l’application doit remplir les conditions suivantes :
  • Les fichiers de l’application sont contenus dans un dossier unique.
  • Le dossier contient le fichier appConfig.properties.
  • Le dossier de l’application est compressé dans un fichier ZIP.
  • La taille maximale du fichier ZIP est de 100 Mo.
Cette procédure nécessite le rôle Administrateur.
Procédez comme suit :
  1. Placez le curseur sur
    Administration
    , puis cliquez sur
    Paramètres de configuration : Déploiement de l'application
    .
  2. Cliquez sur
    Parcourir
    et sélectionnez une application compressée.
  3. Cliquez sur
    Ajouter
    .
    L’application est copiée dans le répertoire d’applications de l'utilisateur. Utilisez la visionneuse d'applications pour afficher l'application dans
    NetOps Portal
    .
Affichage d'une application dans
NetOps Portal
Pour afficher une application, utilisez la vue d'application dans
NetOps Portal
.
L'impression aux formats PDF et CSV et les options de messagerie ne sont pas prises en charge pour les vues d'application.
Procédez comme suit :
  1. Ajoutez ou modifiez un tableau de bord ou une page du contexte d’élément de votre choix.
  2. Ajoutez une vue d’application pour l’application.
  3. Sélectionnez l’application pour la vue.
  4. Mettez à jour les paramètres et la hauteur comme vous le souhaitez.
  5. Cliquez sur
    Enregistrer
    .