Ajouter et configurer une étape Send Web Request (Envoyer une requête Web)

Licence :

Ces fonctions nécessitent une licence pour le rôle ArcGIS Workflow Manager Server Advanced.

L’étape Send Web Request (Envoyer une requête Web) vous permet d’envoyer des requêtes aux extrémités REST pour obtenir des données ou publier des mises à jour. Vous pouvez configurer la réponse de l’extrémité REST comme des valeurs en sortie personnalisées, l’enregistrer en tant que fichier et la joindre à la tâche. Les valeurs en sortie personnalisées peuvent être utilisées pour extraire les jetons des appels REST suivants, diriger le chemin du workflow ou être utilisées en tant qu’entrées pour d’autres étapes.

Lorsque l’étape est exécutée, la requête Web est envoyée à l’extrémité REST définie dans l’étape.

Pour terminer l’étape, cliquez sur Complete Step (Terminer l’étape) .

Configurer l’étape

Procédez comme suit pour configurer l’étape :

Attention :

Afin de réduire les vulnérabilités de sécurité, configurez l’étape Send Web Request (Envoyer une requête Web) uniquement pour des pages Web et des applications Web de confiance.

1. Créez ou mettez à jour un diagramme de processus pour accéder au volet Step Library (Bibliothèque d’étapes).
2. Faites glisser Send Web Request (Envoyer une requête Web) depuis le volet Step Library (Bibliothèque d’étapes) vers une flèche de connexion d’une étape de la zone d’affichage du workflow.

   En savoir plus sur l’ajout d’étapes à un diagramme de processus

   Le volet Step Details (Détails de l’étape) s’affiche.

3. Saisissez un nom pour l’étape dans la zone de texte Step Name (Nom de l’étape).
4. Dans la section Arguments, cliquez sur Edit (Mettre à jour).
5. Cliquez sur la flèche de la liste déroulante URL et sélectionnez le type de requête à envoyer.
6. Saisissez l’URL de l’extrémité REST dans la zone de texte URL.
7. Vous pouvez ajouter des variables de chemin à l’URL avec la syntaxe suivante :

   https://gisserver.domain.com/webadaptorname/apps/workflowmanager/:pathVariable/

   Les variables de chemin apparaissent dans la section Path Variables (Variables de chemin).

8. Vous pouvez également ajouter des paramètres de requête à la requête Web.
   1. Cliquez sur Add Key & Value (Ajouter une clé et une valeur) dans la section Query Parameters (Paramètres de la requête).
   2. Indiquez une clé dans la zone de texte Key (Clé).

      Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

   3. Indiquez une valeur dans la zone de texte Value (Valeur).

      Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

   4. Laissez la case Enabled (Activé) cochée.
   5. Répétez les sous-étapes a à d pour ajouter davantage de paires clé-valeur.
9. Si vous avez ajouté des variables de chemin à l’URL, indiquez une valeur pour chaque variable dans la section Path Variables (Variables de chemin).

   Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

   Conseil :

   Cliquez sur This input supports Arcade Expressions (Cette entrée prend en charge les expressions Arcade) et sélectionnez une expression ArcGIS Arcade pour l’ajouter à la zone de texte associée.

10. Cliquez sur l’onglet Autorisation.
11. Sélectionnez la méthode d’authentification de l’extrémité REST et indiquez des informations d’authentification si nécessaire.

    Attention :

    Les informations d’authentification que vous indiquez dans l’étape ne sont chiffrées. Vous pouvez conserver des informations en toute sécurité en ajoutant un paramètre défini par l’utilisateur chiffré auquel vous pouvez faire référence dans l’étape à l’aide des propriétés de tâche dynamiques.

    Remarque :

    L’option Federated Token (Jeton fédéré) permet d’authentifier les requêtes Web lorsque l’utilisateur effectue l’étape. L’option Federated Token (Jeton fédéré) n’est compatible qu’avec les services publiés sur le même site Enterprise que Workflow Manager.

    1. Le cas échéant, si vous sélectionnez l’option API Key (Clé API) ou Bearer Token (Jeton du porteur), cliquez sur Alternatively Generate Token from Endpoint (Générer alternativement un jeton à partir du point de terminaison).

       La boîte de dialogue Generate Token from Endpoint (Générer alternativement un jeton à partir du point de terminaison) s’affiche.

    2. Configurez des paramètres de jeton afin de générer un jeton pour la requête Web.
12. Vous pouvez cliquer sur l’onglet Headers (En-têtes) pour ajouter des paires clé-valeur d’en-tête personnalisées à la requête Web.
    1. Cliquez sur Add Key & Value (Ajouter une clé et une valeur) dans la section Custom Headers (En-têtes personnalisés).
    2. Indiquez une clé dans la zone de texte Key (Clé).

       Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

    3. Indiquez une valeur dans la zone de texte Value (Valeur).

       Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

    4. Laissez la case Enabled (Activé) cochée.
    5. Répétez les sous-étapes a à d pour ajouter davantage de paires clé-valeur.
13. Vous pouvez cliquer sur l’onglet Body (Corps) pour ajouter des données à la requête Web.

    Le corps de la requête prend en charge les paires clé-valeur de données de formulaire, les paires clé-valeur codées au format URL et les données brutes au format JSON ou texte brut.

    Conseil :

    Vous pouvez également utiliser une expression ArcGIS Arcade pour extraire des paramètres définis par l’utilisateur ou indiquer des valeurs dynamiques dans le texte du corps.

14. Si vous disposez d’une licence pour le rôle ArcGIS Workflow Manager Server Advanced, configurez les paramètres en sortie de l’étape.
15. Si vous le souhaitez, cliquez sur l’onglet Test puis sur Test Response (Réponse au test) pour envoyer la requête configurée et en afficher la réponse.

    Si la requête web contient des expressions Arcade spécifiques à la tâche, vous devez activer la fonction Include Job ID (Inclure l’ID de tâche) et spécifier un ID de tâche dans la zone de texte Job ID (ID de tâche) pour mettre correctement en forme la requête.

16. Cliquez sur Save (Enregistrer) pour fermer la boîte de dialogue Configure Web Request (Configurer la requête Web).
17. Cliquez sur l'onglet Options.
18. Configurez Step Options (Options de l’étape) si nécessaire.
    • Manual (Manuel) : l’étape est exécutée manuellement.
      • Optional (Facultatif) : permet de finaliser la tâche sans l’exécuter.
    • Automatic (Automatique) : l’étape est exécutée dès qu’elle devient active.

      Remarque :

      Si votre diagramme de processus est configuré pour exécuter automatiquement une séquence d’étapes qui comprend l’étape Evaluate Data Quality (Évaluer la qualité des données) ou Run GP Service (Exécuter un service de géotraitement), les étapes censées s’exécuter après l’expiration du jeton utilisateur ayant démarré la séquence d’étapes ne démarrent pas automatiquement. Vous devez disposer d’une licence pour que le rôle ArcGIS Workflow Manager Server Advanced continue d’exécuter davantage d’étapes automatisées sans intervention manuelle.

    • Run on a Schedule (Exécuter selon une planification) : l’étape s’exécute selon une planification que vous définissez.

      En savoir plus sur les options de planification

19. Saisissez éventuellement un texte d’aide pour l’étape dans la zone de texte Step Help (Aide de l’étape).

    Vous pouvez également utiliser des expressions ArcGIS Arcade pour attribuer une valeur dynamique à l’aide de l’étape. Si l’aide de l’étape contient du texte brut et des expressions Arcade, vous devez formater le texte comme suit :

    
    'For further assistance, please contact' + JobCreator($Job) + '.'

20. Cliquez éventuellement sur l’onglet Style pour changer la forme et la couleur de l’étape.
21. Cliquez éventuellement sur l’onglet About (À propos de) et saisissez une description pour l’étape dans la zone de texte Step Description (Description de l’étape).

    Conseil :

    L’onglet About (À propos de) contient également l’ID de l’étape qui peut être utilisé avec les propriétés de tâche dynamiques pour obtenir la sortie d’une étape. Cliquez sur Copy Step ID (Copier l’ID d’étape) pour copier l’ID de l’étape dans le presse-papiers.

Configurer les paramètres de jeton

Si l’extrémité REST à laquelle vous envoyez une requête Web pour exiger un jeton à des fins d’authentification, effectuez ces étapes pour configurer l’étape Envoyer une requête Web afin de générer un jeton pour l’authentification :

1. Cliquez sur la flèche de la liste déroulante URL et sélectionnez le type de requête à envoyer.
2. Saisissez l’URL de l’extrémité REST dans la zone de texte URL.
3. Vous pouvez ajouter des variables de chemin à l’URL avec la syntaxe suivante :

   https://gisserver.domain.com/webadaptorname/apps/workflowmanager/:pathVariable/

   Les variables de chemin apparaissent dans la section Path Variables (Variables de chemin).

4. Vous pouvez également ajouter des paramètres de requête à la requête Web.
   1. Cliquez sur Add Key & Value (Ajouter une clé et une valeur) dans la section Query Parameters (Paramètres de la requête).
   2. Indiquez une clé dans la zone de texte Key (Clé).

      Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

   3. Indiquez une valeur dans la zone de texte Value (Valeur).

      Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

   4. Laissez la case Enabled (Activé) cochée.
   5. Répétez les sous-étapes a à d pour ajouter davantage de paires clé-valeur.
5. Si vous avez ajouté des variables de chemin à l’URL, indiquez une valeur pour chaque variable dans la section Path Variables (Variables de chemin).

   Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

   Conseil :

   Cliquez sur This input supports Arcade Expressions (Cette entrée prend en charge les expressions Arcade) et sélectionnez une expression ArcGIS Arcade pour l’ajouter à la zone de texte associée.

6. Vous pouvez cliquer sur l’onglet Headers (En-têtes) pour ajouter des paires clé-valeur d’en-tête personnalisées à la requête Web.
   1. Cliquez sur Add Key & Value (Ajouter une clé et une valeur) dans la section Custom Headers (En-têtes personnalisés).
   2. Indiquez une clé dans la zone de texte Key (Clé).

      Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

   3. Indiquez une valeur dans la zone de texte Value (Valeur).

      Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.

   4. Laissez la case Enabled (Activé) cochée.
   5. Répétez les sous-étapes a à d pour ajouter davantage de paires clé-valeur.
7. Vous pouvez cliquer sur l’onglet Body (Corps) pour ajouter des données à la requête Web.

   Le corps de la requête prend en charge les paires clé-valeur de données de formulaire, les paires clé-valeur codées au format URL et les données brutes au format JSON ou texte brut.

   Conseil :

   Vous pouvez également utiliser une expression ArcGIS Arcade pour extraire des paramètres définis par l’utilisateur ou indiquer des valeurs dynamiques dans le texte du corps.

8. Cliquez sur l’onglet Token (Jeton).
9. Cliquez sur le bouton bascule Test Mode (Mode test) dans la section Token (Jeton).
10. Collez un exemple de réponse de l’extrémité REST dans la zone de texte Sample Response (Exemple de réponse).

    Exemple de réponse au format JSON :

    {"access_token": "12345abcde",
    "expires_in":7199,
    "spatialReference": {
      "wkid": 4326,
      "latestWkid": 4326
    },
    "location": [
      {
        "name": "380 New York Street",
        "extent": {
          "xmin": -117.196701,
          "ymin": 34.055489
        }
      }
    ]}

11. Indiquez un nom pour le jeton dans la zone de texte Output Value (Valeur en sortie).

    Il s’agit du nom utilisé par l’étape pour référencer le jeton généré.

12. Indiquez une expression JSONPath en notation par points ou en notation par crochets dans la zone de texte Extraction Path (Chemin d’extraction) pour analyser la réponse et renvoyer le jeton généré.

    Exemple d’expression JSONPath en notation par points :

    $.access_token

    Exemple d’expression JSONPath en notation par crochets :

    $['access_token']

    La valeur apparaît dans la colonne Sample Result (Exemple de résultat).

13. Cliquez sur Back to Step Configuration (Retour à la configuration de l’étape) pour continuer à configurer l’étape.

Configurer les paramètres en sortie

Licence :

Ces fonctions nécessitent une licence pour le rôle ArcGIS Workflow Manager Server Advanced.

Vous pouvez enregistrer la réponse de l’extrémité REST en tant que fichier, la joindre à la tâche et la configurer en tant que valeurs en sortie personnalisées. Les valeurs en sortie peuvent être utilisées pour diriger les chemins des workflows ou comme entrées d’autres étapes. Si aucune valeur en sortie n’est configurée pour l’étape, le code de statut HTTP est stocké en tant que valeur en sortie de l’étape. Pour configurer les paramètres en sortie de l’étape, procédez comme suit :

1. Cliquez sur l’onglet Output (Sortie) dans la boîte de dialogue Configure Web Request (Configurer la requête Web).

   Si la boîte de dialogue Configure Web Request (Configurer la requête Web) n’est pas disponible, cliquez sur l’étape Send Web Request (Envoyer une requête Web) dans la zone d’affichage du workflow, puis cliquez sur Edit (Mettre à jour) dans la section Arguments du volet Step Details (Détails de l’étape).

2. Vous pouvez cliquer sur le bouton bascule Enabled (Activé) dans la section Attach Response (Joindre une réponse) pour enregistrer la réponse de l’extrémité REST en tant que fichier et joindre ce dernier à la tâche.
3. Si vous le souhaitez, configurez le nom de la pièce jointe et le dossier dans lequel la réponse sera stockée :
   1. Indiquez le nom du dossier dans lequel la pièce jointe sera stockée dans la zone de texte Folder Name (Nom du dossier).

      Le nom du dossier ne peut pas contenir de chemin du système de fichiers et de caractères spéciaux. Si vous n’indiquez pas de nom, un dossier nommé General (Général) est créé automatiquement.

      Remarque :

      Le dossier est contenu dans l’élément de processus et n’est pas un chemin du système de fichiers.

   2. Sélectionnez l’une des options Attachment Name (Nom de la pièce jointe) suivantes :
      • Autogenerated (Généré automatiquement) : nomme automatiquement la pièce jointe avec la syntaxe suivante : <NomÉtape>_<DateExécution>_<HeureExécution>.
      • Custom (Personnalisé) : permet d’indiquer un nom de pièce jointe personnalisé.
4. Si vous le souhaitez, configurez des valeurs en sortie personnalisées pour la réponse de l’extrémité REST :
   1. Cliquez sur le bouton bascule Test Mode (Mode test) dans la section Output Values (Valeurs en sortie).
   2. Collez un exemple de réponse de l’extrémité REST dans la zone de texte Sample Response (Exemple de réponse).

      Exemple de réponse au format JSON :

      {"access_token": "",
      "expires_in":7199,
      "spatialReference": {
        "wkid": 4326,
        "latestWkid": 4326
      },
      "location": [
        {
          "name": "380 New York Street",
          "extent": {
            "xmin": -117.196701,
            "ymin": 34.055489
          }
        }
      ]}

   3. Cliquez sur Add Output & Path (Ajouter une sortie et un chemin).
   4. Indiquez un nom pour la valeur en sortie dans la zone de texte Output Value (Valeur en sortie).

      Il s’agit du nom de valeur utilisé pour l’obtention de la valeur en sortie personnalisée.

   5. Indiquez une expression JSONPath en notation par points ou en notation par crochets pour la valeur que vous souhaitez stocker dans la zone de texte Extraction Path (Chemin d’extraction).

      Exemple d’expression JSONPath en notation par points :

      $.location.0.name

      Exemple d’expression JSONPath en notation par crochets :

      $['location'][0]['name']

      La valeur apparaît dans la colonne Sample Result (Exemple de résultat).

   6. Au besoin, répétez les sous-étapes c à e pour ajouter davantage de valeurs en sortie personnalisées.
5. Cliquez sur Save (Enregistrer) pour fermer la boîte de dialogue Configure Web Request (Configurer la requête Web).

retourner une valeur

Une fois l’étape terminée, sa valeur de retour est stockée pour indiquer le résultat de l’étape. La valeur de retour peut être immédiatement évaluée en utilisant des chemins pour déterminer les prochaines étapes du processus. Vous pouvez également récupérer la valeur de retour des étapes terminées tout au long du processus à l’aide d’expressions ArcGIS Arcade. Le tableau suivant indique les valeurs de retour de l’étape :

retourner une valeur	Description
S000001	L’étape s’est terminée correctement.
F000001	L’étape ne s’est pas terminée correctement.

Valeur en sortie

Licence :

Ces fonctions nécessitent une licence pour le rôle ArcGIS Workflow Manager Server Advanced.

Une fois l’étape terminée, sa valeur en sortie est stockée et peut être utilisée pour déterminer le chemin suivi par le processus. Elle peut également servir d’entrée pour d’autres étapes tout au long du processus. Le tableau suivant indique la valeur en sortie de l’étape :

Sortie	Description
Statut	Renvoie le code de réponse HTTP si aucune valeur en sortie n’est configurée pour l’étape.
<CustomOutputValue>	Renvoie la valeur en sortie personnalisée que vous avez configurée pour l’étape.
attachmentId	Renvoie une matrice des ID de pièce jointe ajoutés à l’étape.