Paramétrage des web services SOAP


UseRestInsteadOfSoap

Note : Les web services SOAP Service Manager ne sont plus maintenus depuis la version Oxygène. Vous pouvez toujours les utiliser mais nous vous conseillons d'utiliser l'API REST Service Manager pour profiter des dernières améliorations et fonctionnalités.

Au travers des étapes des processus (workflows / processus liés à une règle métier) définies via l'éditeur graphique, Service Manager peut appeler des web services externes SOAP de Service Manager ou d'autres produits.

exemple  Appel d'un composant externe de réinitialisation des mots de passe

Le web service SOAP externe appelé par Service Manager doit être déclaré et configuré au préalable avant de pouvoir être utilisé dans un processus.

Accès menu

Administration > Paramétrages > Web services

Description des écrans

Informations d'accès au web service

        Web service - step 1.png

WSDL (URL) : Adresse URL du web service.

Best Practice icon.png  Consultez l'annuaire UDDI (Universal Description Discovery and Integration) recensant les web services déclarés par les fournisseurs.

Login / Mot de passe : Login / mot de passe d'accès au web service.

Proxy : Proxy utilisé par le web service.

Fichiers attachés : Ensemble des certificats nécessaires pour l'accès à un web service sécurisé.

  • Un certificat SSL est nécessaire lorsque l'adresse URL commence par https.
  • Cliquez sur Upload icon.png pour télécharger un fichier (certificat, certificat racine, clé privée).
  • La saisie du mot de passe du certificat est masquée par des * pour des raisons de confidentialité.

Description du web service

        Web service - step 2.png

Nom : Libellé du web service chez le consommateur.

Commentaire : Description du web service communiquée par le consommateur.

Service (Note : Non modifiable) : Libellé du web service chez le fournisseur.

Port (Note : Non modifiable) : Adresse du web service communiquée par le fournisseur.

Méthode : Nom de la procédure d'appel dans le web service.

Valeurs des paramètres du web service

        Web service - step 3.png

Documentation (Note : Non modifiable) : Description du web service communiquée par le fournisseur.

Paramètre : Liste des paramètres du web service.

Valeur : Valeur par défaut de chaque paramètre. Cliquez sur Edit icon.png pour la renseigner.

Valeur de retour attendue : Valeur renvoyée par le web service lorsqu'il s'est exécuté sans erreur. 

  • Ne renseignez pas ce champ si le web service renvoie une chaîne variable.

    exemple  Envoi d'un nouveau mot de passe par le web service Réinitialisation des mots de passe

  • La valeur de retour est utilisée au niveau d'une étape WebService d'un processus pour évaluer sa valeur de sortie :
    • Valeur retournée par le web service = Valeur de retour attendue : aucune erreur. Poursuite du processus ==> Valeur de sortie de l'étape WebService = Vrai
    • Valeur retournée par le web service <> Valeur de retour attendue : erreur. Fin du processus ==> Valeur de sortie de l'étape de WebService = Faux. Traitement de l'erreur (Orientation vers une étape de gestion des erreurs, Notification de l'erreur via un e-mail ou un fichier log...) 
  • Si la valeur de retour n'est pas renseignée, la valeur de sortie de l'étape WebService est Vrai.

Procédure et Assistants

Comment gérer dans un processus le résultat d'un web service SOAP

Les workflows et les processus liés à une règle métier peuvent contenir des actions de type WebService appelant des web services SOAP.

  • Toutes les web services SOAP Service Manager peuvent être appelés.
  • Le résultat de l'appel du web service (Succès / Erreur) peut être géré via des étapes de mise à jour interne.
     

exemple  Appel d'un web service de réinitialisation des mots de passe

  • Étape de succès = Étape d'envoi de mail pour envoyer à l'utilisateur son nouveau mot de passe
  • Étape d'erreur = Étape d'envoi de mail pour notifier l'erreur renvoyée par le web service
    Example web service - Workflow.png

Étape 1 : Création et paramétrage du web service SOAP

1. Allez sur l'écran Administration > Paramétrages > Web services.

2. Cliquez sur + Nouveau dans le bandeau supérieur.

3. Renseignez les informations du web service en faisant défiler les différentes étapes via Suivant.

4. Cliquez sur Terminer.

Modification d'un web service

  • Allez sur la liste des web services.
  • Sélectionnez le web service dans la liste.
  • Lancez l'assistant Éditeur de web service.
     

Étape 2 : Sélection du processus

1. Ouvrez le processus dans lequel le web service doit être utilisé.

  • Workflow : Références > Autres références > Workflows (Operation / Transition)
  • Règle métier : Administration > Règles métier > Processus associés
     

Étape 3 : Création de l'étape appelant le web service SOAP

1. Cliquez-glissez le type d'action Étape WebService depuis la palette des types d'actions (catégorie Actions automatiques) vers l'éditeur graphique.

2. Renseignez les propriétés de l'étape en double-cliquant sur son cadre.

  • Sélectionnez le web service SOAP dans le champ Référence de WEBService.
  • Renseignez les paramètres utilisés par le web service. Note : Les paramètres définis à la configuration sont automatiquement affichées.
  • Définissez une variable d'instance pour stocker la valeur renvoyée par le web service.
    • Type de la valeur : Variable qui indique que la variable d'instance est estimée au moment de l'exécution du processus.
    • Variable / Valeur : @RESULT qui fait référence au résultat de l'appel du web service.
       

Étape 4 : Création de l'étape ayant la valeur de sortie Succès

1. Cliquez-glissez le type d'action Étape de mise à jour interne depuis la palette des types d'actions (catégorie Actions automatisées) vers l'éditeur graphique.

2. Renseignez les propriétés de l'étape en double-cliquant sur son cadre  - Open url.png voir Éditeur graphique > Description d'une étape

  • Définissez la condition d'entrée.
    • Sélectionnez l'étape liée au web service créée précédemment.
    • Sélectionnez Vrai comme valeur de sortie, indiquant que l'appel du web service s'est déroulé avec succès.
       

Étape 5 : Création de l'étape ayant la valeur de sortie Erreur

1. Cliquez-glissez le type d'action Étape de mise à jour interne depuis la palette des types d'actions (catégorie Actions automatisées) vers l'éditeur graphique.

2. Renseignez les propriétés de l'étape en double-cliquant sur son cadre.

  • Définissez la condition d'entrée.
    • Sélectionnez l'étape liée au web service créée précédemment.
    • Sélectionnez Faux comme valeur de sortie, indiquant que l'appel du web service a échoué.

Les assistants

Éditeur de Web Service

Tags:
Modifié par Utilisateur inconnu le 2021/12/20 15:18
Créé par Administrator XWiki le 2013/03/25 18:23

Raccourcis

L'actualité mensuelle
•  Newsletter

Tous les changements
•  Service Manager
•  Service Apps
•  Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021