Étape SOAP

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 8 minutes de lecture

    • Activez les designers d'actions pour envoyer des demandes de service Web SOAP sortantes à des systèmes externes.

    Remarque :
    Étape SOAP n’est pas disponible dans le système de base et requiert l’abonnement ServiceNow® Hub d'intégration . Une fois le module d’extension requis activé, l’étape est visible sous Intégrations.

    Rôles et disponibilité

    • Disponible en tant qu’étape d’action Concepteur d'action . Les utilisateurs disposant du rôle action_designer peuvent créer une action personnalisée avec une ou plusieurs étapes d’action.
    • Les designers d’actions ont besoin du rôle web_service_admin pour effectuer ces tâches de services Web.
      • Sélectionner WSDL
      • Charger le nouveau WSDL
      • Sélectionner une politique de sécurité WS
    • Le ServiceNow® Serveur MID ne prend pas en charge les politiques de sécurité WS.

    Champs

    Champ Description
    Détails de la connexion
    Connexion Le type de connexion à utiliser.
    • Définir l’inline de la connexion : Définissez les informations de connexion dans l'étape d'action.
    • Utiliser un alias de connexion : Définissez les informations de connexion à l'aide de la table Alias de connexion. L'utilisation d'un alias élimine la nécessité de configurer plusieurs informations d'identification et profils d'informations de connexion lors de l'utilisation d'une action dans plusieurs environnements. De même, si les informations de connexion changent, vous n'avez pas besoin de mettre à jour votre action personnalisée.

    Pour en savoir plus sur les connexions et les informations d’identification, consultez Introduction aux informations d’identification, aux connexions et aux alias.
    Alias de connexion Enregistrement d’alias de connexion et d’informations d’identification que le système utilise pour exécuter l’étape d’action. Les utilisateurs disposant du rôle flow_designer ou administrateur peuvent créer ou sélectionner un enregistrement de connexion associé. L'utilisation d'un alias élimine la nécessité de configurer plusieurs informations d'identification et profils d'informations de connexion lors de l'utilisation d'une action dans plusieurs environnements. De même, si les informations de connexion changent, vous n’avez pas besoin de mettre à jour votre action personnalisée. Pour en savoir plus sur les connexions et les informations d’identification, consultez Informations d’identification, connexions et alias. La valeur d’informations d’identification est affichée sous la forme d’une pastille de données Mot de passe (2 voies cryptées) sur le panneau de données.
    Remarque :
    Ce champ est disponible lorsque l’option Utiliser des alias de connexion est sélectionnée dans la liste Connexion.
    Alias d’informations d’identification Alias d’informations d’identification utilisé par le système pour exécuter l’étape d’action. Les utilisateurs disposant du rôle flow_designer ou administrateur peuvent créer ou sélectionner un enregistrement de connexion associé. L’utilisation d’un alias élimine la nécessité de configurer plusieurs informations d’identification lors de l’utilisation d’une action dans plusieurs environnements. De même, si les informations d’identification changent, vous n’avez pas besoin de mettre à jour votre action personnalisée. Pour en savoir plus sur les connexions et les informations d’identification, consultez Informations d’identification, connexions et alias. La valeur d’informations d’identification est affichée sous la forme d’une pastille de données Mot de passe (2 voies cryptées) sur le panneau de données.
    Remarque :
    Ce champ est disponible lorsque l’option Définir l’inline de la connexion est sélectionnée dans la liste Connexion.
    Utiliser MID Option permettant d’utiliser un Serveur MID pour exécuter le Étape SOAPfichier . Cochez cette case pour afficher les champs Sélection MID, Application MID et Options .
    Remarque :
    Ce champ est disponible lorsque l’option Utiliser des alias de connexion est sélectionnée dans la liste Connexion.
    Point de terminaison Point de terminaison de l’URL pour la demande SOAP. Si l’option Utiliser des alias de connexion est sélectionnée, ce champ est en lecture seule et affiche l’URL de point de terminaison associée à l’alias. Si l’option Définir l’inline de la connexion est sélectionnée, entrez une URL de point de terminaison pour la connexion.
    Tester l'étape SOAP Bouton pour tester l’étape SOAP. Pour effectuer le test, sélectionnez le bouton Tester l’étape SOAP . Saisissez toutes les valeurs d’entrée requises et sélectionnez le bouton Exécuter le test . Après l’exécution du test, les sorties d’étape ou les messages d’erreur sont affichés dans la section Résultats des tests de la fenêtre de test.
    Délai de connexion Nombre de millisecondes pendant lesquelles le système attend une connexion de l'hôte réussie. Si l’étape n’aboutit pas à la connexion pendant cette durée, la demande de connexion expire. Si l’option Définir l’inline de la connexion est sélectionnée, entrez une valeur de délai d’expiration pour la connexion. Laissez ce champ vide pour utiliser la valeur de délai de connexion par défaut du système.
    Sélection de MID Option permettant de sélectionner le MID Server ou la grappe MID spécifique.
    • Sélectionner automatiquement un MID Server : sélectionne automatiquement le MID Server.
    • MID Server spécifique : utilise le MID Server que vous sélectionnez.
    • Grappe MID spécifique : utilise la grappe MID que vous sélectionnez.
    Ce champ est disponible lorsque l’option Définir l’inline de la connexion est sélectionnée dans la liste Connexion et que l’option Utiliser MID est cochée.
    Grappe MID Pastille de données pour la grappe MID que vous souhaitez utiliser. Ce champ est disponible lorsque l’option Définir l’inline de la connexion est sélectionnée dans la liste Connexion, que l’option Utiliser MID est sélectionnée et que la grappe MID spécifique est sélectionnée dans la liste Sélection MID.
    Détails de la demande
    Enveloppe de version Méthode à utiliser lors de la construction de l’enveloppe SOAP.
    • À partir de WSDL : sélectionnez cette option pour afficher les champs Sélectionner un WSDL et Opération .
    • Manuellement : sélectionnez cette option pour saisir ou coller manuellement du texte WSDL.
    Sélectionner un WSDL WSDL à utiliser pour construire l’enveloppe SOAP. Sélectionnez un enregistrement WSDL existant ou cliquez sur Charger un nouveau WSDL pour télécharger ou saisissez manuellement un fichier WSDL. Le WSDL sélectionné renseigne les valeurs des champs Opération, Action SOAP et Enveloppe SOAP .
    Remarque :
    Ce champ est disponible lorsque vous sélectionnez À partir de WSDL dans la liste Enveloppe de version.
    Charger le nouveau WSDL Option pour télécharger ou saisir manuellement un fichier WSDL.
    Opération Opération à exécuter à partir du WSDL sélectionné. Chaque WSDL a sa propre liste d’opérations disponibles.
    Action SOAP URL d’exécution de l’action SOAP. Si l’enveloppe de version est définie sur À partir de WSDL, ce champ est en lecture seule et affiche l’URL d’exécution de l’action SOAP. Si l’enveloppe de version est définie sur Manuellement, entrez une URL pour exécuter l’action SOAP.
    Type de demande Format de la demande. Les options incluent.
    • Texte : demande au format JSON ou XML ou dans un autre format texte.
    • Binaire : demande effectuée dans un format de fichier binaire.
    Enveloppe SOAP Texte XML envoyé au point de terminaison. Si l’enveloppe de version est définie sur À partir de WSDL, le système ajoute le code XML nécessaire pour l’opération que vous sélectionnez. Si l’enveloppe de version est définie sur Manuellement, entrez le texte XML que vous souhaitez utiliser. Entrez les valeurs d’enregistrement dans les éléments d’enveloppe SOAP appropriés. Par exemple, saisissez une brève description d’incident dans l’élément <short_description> .
    Remarque :
    Ce champ est disponible lorsque le type de demande est Texte.
    Pièce jointe Enregistrement de la pièce jointe qui contient la demande. Vous pouvez rechercher ou créer cet enregistrement dans une étape préalable et le définir comme variable d’entrée. Créez-le à l’aide des API JSONStreamingBuilder et XMLStreamingBuilder à l’étape Script.
    Remarque :
    Ce champ est disponible lorsque le type de demande est Binaire.
    Enveloppe de réinitialisation Option permettant d’annuler tous les changements manuels que vous avez apportés à l’enveloppe SOAP. Cochez cette case pour rétablir l’état d’origine de l’enveloppe SOAP.
    Remarque :
    Ce champ est disponible lorsque vous sélectionnez À partir de WSDL dans la liste Enveloppe de version.
    Nouveau WSDL
    Nom Nom de l’enregistrement WSDL que vous souhaitez créer.
    Méthode d'importation Méthode pour entrer WSDL.
    • Télécharger à partir de l’URL : sélectionnez cette option pour afficher les champs URL WSDL, Nom d’utilisateur et Mot de passe afin de récupérer le WSDL à partir d’une source externe, généralement le fournisseur de services Web.
    • Renseigner manuellement le contenu WSDL : sélectionnez cette option pour afficher le champ Contenu WSDL afin de saisir ou coller manuellement du texte WSDL.
    URL WSDL URL du service Web SOAP.
    Remarque :
    Ce champ est disponible lorsque vous sélectionnez Télécharger à partir de l’URL dans la liste Méthode d’importation.
    Nom d'utilisateur Nom d’utilisateur à authentifier auprès du service Web SOAP.
    Remarque :
    Ce champ est disponible lorsque vous sélectionnez Télécharger à partir de l’URL dans la liste Méthode d’importation.
    Mot de passe Mot de passe permettant de s’authentifier auprès du service Web SOAP. Le système masque toujours les mots de passe dans l’interface utilisateur et empêche de les exporter sous forme de texte brut.
    Remarque :
    Ce champ est disponible lorsque vous sélectionnez Télécharger à partir de l’URL dans la liste Méthode d’importation.
    Contenu WSDL Document XML décrivant le service Web SOAP et ses opérations.
    Remarque :
    Ce champ est disponible lorsque vous sélectionnez Remplir manuellement le contenu WSDL dans la liste Méthode d’importation.
    Importer Option permettant d’ajouter le WSDL du service Web SOAP à l’instance.
    Utiliser pour la sécurité WS
    Activer la politique de sécurité WS Option permettant de restreindre le service Web SOAP à une politique de sécurité. Cochez cette case pour afficher le champ Politique .
    Politique Enregistrement de politique que vous souhaitez utiliser pour restreindre les connexions de services Web. Sélectionnez un enregistrement de politique existant.
    Politique des nouveaux essais
    Activer la politique des nouveaux essais Option permettant d'activer la politique des nouveaux essais. Pour plus d'informations, reportez-vous à Politique des nouveaux essais.
    Remplacer la politique des nouveaux essais pour l’alias Option permettant de remplacer la politique des nouveaux essais par défaut. Cette case à cocher n'est pas disponible si l'option Définir l'inline de la connexion est sélectionnée dans la liste des connexions.
    Politique des nouveaux essais Politique des nouveaux essais par défaut associée à l'alias de connexion. Si l'option Remplacer la politique des nouveaux essais pour l'alias est sélectionnée, vous pouvez remplacer la politique des nouveaux essais par défaut et sélectionner une autre politique existante des nouveaux essais en fonction de vos besoins.
    Options avancées
    En-têtes Paires nom-valeur à inclure dans le message SOAP en tant qu’en-têtes HTTP. Cliquez sur l’icône Plus pour ajouter des en-têtes. Ajoutez un nom et une valeur pour chaque en-tête HTTP.
    En-têtes > Omettre si vide Option pour exclure un en-tête si la valeur est vide ou nulle.
    Remarque :
    Cette case à cocher est disponible après avoir cliqué sur la flèche vers le bas pour afficher les options avancées.

    Champs d’évaluation des erreurs d’action

    Champ Description
    En cas d'échec de cette étape Option permettant de continuer à exécuter l’étape suivante ou d’accéder à l’évaluation des erreurs. Pour utiliser le code d’état ou le message de l’étape pour une condition d’erreur d’action personnalisée, reportez-vous à Action error evaluation.

    Limite de taille de la réponse SOAP

    Le système limite la taille des réponses SOAP à 5 Mo. Les réponses SOAP directes qui dépassent cette limite génèrent une erreur. Pour prendre en charge des tailles de réponse plus grandes, augmentez la limite de taille de réponse avec la glide.pf.soap.response_payload_max_size propriété système. Cette propriété système prend en charge une valeur maximale de 10 Mo.