Créer un spoke et créer des actions en important une spécification OpenAPI

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 5 minutes de lecture
  • Automatisez une intégration et générez des actions réutilisables en important une spécification OpenAPI.

    Avant de commencer

    • Installez l’application Générateur de spokes à partir du ServiceNow Store.
    • Rôle requis : admin

    Procédure

    1. Accédez à la Tout > Automatisation des processus > Studio de workflow.
    2. Cliquer sur Créer > Spoke.
    3. Dans l’écran Informations sur le spoke, spécifiez si vous souhaitez créer le spoke dans un nouveau périmètre ou dans un périmètre existant.
      1. Si vous choisissez de créer le spoke dans un nouveau champ d’application, sélectionnez une image comme logo de votre intégration et renseignez les champs.

        Ici, nous allons passer en revue une intégration avec Zoom à titre d’exemple.

        Champ Description
        Nom de spoke Nom permettant d’identifier le spoke personnalisé.
        Description Description du spoke personnalisé.

        Créez un spoke dans un nouveau périmètre.

        Remarque :

        La valeur du nom du périmètre de l’application est le format suivant : x_<company-code>_<spoke-name>_<spoke>. Par défaut, le <company-code> est snc. Vous pouvez configurer le code de société en configurant la valeur de la propriété système, glide.appcreator.company.code.Configuration de la valeur de glide.appcreator.company.code.

        Cette valeur configurée est utilisée lorsque la valeur Nom du périmètre de l’application est générée.Valeur configurée du nom du périmètre de l’application.

      2. Si vous choisissez de créer le spoke dans un périmètre existant, sélectionnez une image comme logo de votre intégration et renseignez les champs.

        Ici, nous allons passer en revue une intégration avec AWS à titre d’exemple.

        Champ Description
        Nom de l'application Un nom ou un périmètre d’application existant.

        Sélectionnez une application existante.

        Nom du champ de l'application Nom du champ d’application renseigné automatiquement en fonction du nom de l’application sélectionnée.
        Description Description du spoke personnalisé.

        Créez un spoke dans un périmètre existant.

    4. Cliquez sur Continuer.

      En fonction du nom et de la description fournis, s’il existe des spokes correspondants dans le magasin, les détails du spoke s’affichent.Spokes correspondants trouvés dans l’App Store.

      1. Cliquez sur Afficher les détails sur Store pour afficher les détails des spokes correspondants.
        Les détails des spokes correspondants sont affichés dans un nouvel onglet de navigateur.
      2. Installez le spoke à partir du magasin.
        Pour en savoir plus, consultez Install a ServiceNow Store application.
      3. Après avoir installé le spoke, accédez à l’onglet Studio de workflow .
        Le système affiche le message Avez-vous installé un spoke à partir du magasin ?.
      4. Sélectionnez l’une de ces options et cliquez sur Continuer.
        Option Description
        Oui, afficher le spoke installé. Option de redirection vers le tableau de bord des spokes sous Intégrations.
        Non, je vais élaborer un spoke personnalisé. Option permettant de poursuivre la création de spoke.
        Non, je veux quitter la création de spoke. Option permettant de fermer l’onglet actif.
    5. Cliquez sur Ignorer si vous souhaitez créer le spoke personnalisé.
      Remarque :
      Les étapes suivantes s’appliquent également si vous avez sélectionné l’option Non, je vais créer un spoke personnalisé.

      Le spoke est créé et un message de confirmation s’affiche.

    6. Sur l’écran Informations sur la version, sélectionnez la méthode à l’aide de laquelle vous souhaitez créer votre spoke.
      Vous pouvez choisir de créer votre spoke à l’aide de la spécification OpenAPI ou de la collection Postman.
    7. Sélectionnez Spécification OpenAPI, puis cliquez sur Continuer pour importer une spécification OpenAPI.
      Sélectionnez la méthode à utiliser pour créer votre spoke.
    8. Pour Source OpenAPI, cliquez sur Importer nouveau.
    9. Sur l’écran Importer une nouvelle source OpenAPI, effectuez l’une des deux étapes suivantes.
      1. Si vous souhaitez importer à l’aide d’une URL, sélectionnez Importer à partir de l’URL pour Méthode d’importation et spécifiez l’URL dans l’URL OpenAPI.
        Importer une nouvelle source OpenAPI.
      2. Si vous souhaitez importer manuellement à l’aide du code JSON ou YAML, sélectionnez Importer manuellement à partir de JSON ou YAML pour Méthode d’importation et fournissez le code au format JSON ou YAML.
        Créez un spoke manuellement en important JSON ou YAML.
    10. Cliquez sur Importer.
      La source OpenAPI est importée.
    11. Pour Alias de connexion et d’informations d’identification, cliquez sur Créer.
    12. Sur l’écran Créer un alias de connexion et d’informations d’identification, renseignez les champs et fournissez les informations sur l’alias.
      Champ Description
      Nom de connexion et d’informations d’identification Nom permettant d’identifier l’enregistrement d’alias de connexion et d’informations d’identification.
      Modèle de configuration pour authentification Mécanisme d’authentification requis pour cette intégration. Assurez-vous que le mécanisme d’authentification est compatible avec la source OpenAPI.
      Remarque :
      Le modèle de configuration est renseigné automatiquement en fonction de la spécification OpenAPI que vous avez fournie. Vous pouvez continuer avec l’option par défaut ou la modifier selon vos besoins.
      Créez un alias de connexion pour le spoke.
    13. Cliquez sur Créer un alias et continuez.
    14. Sur le même écran, renseignez les champs pour configurer l’alias.
      Champ Description
      Information de connexion
      Nom de la connexion Nom permettant d’identifier l’enregistrement de connexion.
      URL de connexion URL de base pour se connecter à l’instance ou au serveur tiers. Cette URL est renseignée automatiquement en fonction de la spécification OpenAPI que vous avez fournie.
      Informations d'identification
      Selon le modèle de configuration que vous avez sélectionné, les champs d’informations d’identification pertinents s’affichent. Fournissez les valeurs requises pour configurer l’enregistrement des informations d’identification.
      Configurez les enregistrements de connexion et d’informations d’identification.

      Si vous souhaitez configurer l’enregistrement d’alias ultérieurement, cliquez sur Effectuer cette opération ultérieurement.

    15. Cliquez sur Envoyer.
      L’enregistrement d’alias de connexion est créé.
    16. Cliquez sur Générer des opérations.
      Générer des opérations pour le spoke.
      Toutes les opérations qui peuvent être effectuées à l’aide de la spécification OpenAPI sont répertoriées.
    17. Sélectionnez les opérations requises.

      Vous pouvez rechercher les actions requises en saisissant le terme requis dans la barre de recherche. Les actions qui correspondent au terme de recherche spécifié s’affichent.

      Recherchez les actions requises.
    18. Cliquez sur Publier.
      Sinon, vous pouvez également sélectionner Enregistrer les actions comme brouillon pour enregistrer les actions comme brouillon, les modifier selon vos besoins et les publier ultérieurement.Créez des actions de spoke.
    19. Cliquez sur Terminé : accéder au spoke pour accéder à la page Spokes et afficher l’état de publication.
      • Des actions avec l’étape OpenAPI sont créées. Pour plus d’informations sur l’étape OpenAPI, reportez-vous à la section OpenAPI support in the REST step.
      • Les entrées et sorties d’action sont mappées.
      • Les actions sont publiées et répertoriées dans la page des détails du spoke sous Actions > Publiés.

      Vous pouvez commencer à utiliser ces actions publiées pour créer des flux et des flux secondaires selon vos besoins.

      • Si vous avez enregistré des actions en tant que brouillon, vous pouvez accéder à ces actions préliminaires dans la page des détails du spoke sous Actions > Brouillon.
      • Pour afficher des informations d’exécution sur les activités du spoke, cliquez sur Journal d’activité du spoke dans la page des détails du spoke. Chaque fois qu’une activité de spoke est effectuée, le système génère ses informations sous la forme d’un journal d’activité de spoke. Cliquez sur le nombre requis pour afficher le journal d’activité. Chaque opération dans le journal d’activité du spoke présente l’une des valeurs d’état suivantes :
        Statut Description
        Nouveau Un événement pour l’opération est créé et cette opération sera exécutée prochainement.
        erreur Échec de l’exécution de l’opération.
        traitement L’exécution de l’opération est en cours.
        réussite L’opération a été exécutée avec succès.

      Vous pouvez créer des flux et des flux secondaires dans la page des détails du spoke et les utiliser dans votre intégration. Pour plus d'informations, consultez Création de flux et Création de flux secondaires.

      Outre le journal d’activité du spoke, vous pouvez également afficher les détails des flux, des flux secondaires et des actions disponibles dans la page des détails du spoke.