Créer et gérer des modèles de requête web

Licence :

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

Les modèles de requête web peuvent être utilisés de pair avec des activités de tâche pour envoyer automatiquement des requêtes web aux extrémités REST lorsque des activités de tâche spécifiques ont lieu. Par exemple, le modèle de requête Web peut être configuré pour extraire des données ou publier des mises à jour sur un système tiers lorsqu’une tâche est mise à jour.

Créer des modèles de requête web

Pour créer des modèles de requête web, procédez comme suit :

1. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Remarque :

   If you don't have sufficient privileges, the Design tab is not available.

3. Click Templates .

   Remarque :

   If you don’t have sufficient privileges, the Templates button is not available.

4. Click the Web Request tab.

   The Web Request panel appears.

   Remarque :

   If you don’t have sufficient privileges, the Web Request tab is not available.

5. Cliquez sur Create New (Créer) dans le volet Web Request (Requête web).
6. Indiquez un nom pour le modèle de requête web dans la zone de texte Name (Nom).
7. Cliquez sur la flèche de la liste déroulante URL et sélectionnez le type de requête à envoyer.
8. Saisissez l’URL de l’extrémité REST dans la zone de texte URL.
9. 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).

10. Vous pouvez également ajouter des paramètres de requête au modèle de 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é).

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

    You can also use ArcGIS Arcade expressions to provide a dynamic value.

    Conseil :

    Click This input supports Arcade Expressions and choose an ArcGIS Arcade expression to add it to its associated text box.

12. Cliquez sur l’onglet Autorisation.
13. 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 fournissez ne sont chiffrées. Pour sécuriser les informations, ajoutez un paramètre défini par l’utilisateur chiffré afin de stocker ces informations et référencez-le dans le modèle à l’aide des propriétés de tâche dynamiques.

    Remarque :

    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).

       Les paramètres Generate Token from Endpoint (Générer un jeton à partir de l’extrémité) apparaissent dans le volet Web Request (Requête Web).

    2. Configurez des paramètres de jeton afin de générer un jeton pour la requête Web.
14. Vous pouvez cliquer sur l’onglet Headers (En-têtes) pour ajouter des paires clé-valeur d’en-tête personnalisées au modèle de 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é).

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

    4. Laissez la case Enabled (Activé) cochée.
    5. Répétez les sous-étapes a à d pour ajouter davantage de paires clé-valeur.
15. 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.

16. Si vous disposez d’une licence pour ArcGIS Workflow Manager Server Advanced, vous pouvez configurer les paramètres en sortie du modèle de requête web.

    Remarque :

    Pour tester la valeur en sortie de la requête web, le modèle doit être terminé au préalable.

17. 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.

Configurer les paramètres de jeton

Si l’extrémité REST nécessite un jeton pour l’authentification, effectuez ces étapes pour configurer le modèle de requête Web afin de générer un jeton pouvant être utilisé pour authentifier les requêtes Web.

1. Dans l’onglet Authorization (Autorisation), sélectionnez l’option API Key (Clé API) ou Bearer Token (Jeton du porteur), puis cliquez sur Alternatively Generate Token from Endpoint (Générer alternativement un jeton à partir de l’extrémité).

   Les paramètres Generate Token from Endpoint (Générer un jeton à partir de l’extrémité) apparaissent dans le volet Web Request (Requête Web).

2. Cliquez sur la flèche de la liste déroulante URL et sélectionnez le type de requête à envoyer.
3. Saisissez l’URL de l’extrémité REST dans la zone de texte URL.
4. 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).

5. 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é).

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

   You can also use ArcGIS Arcade expressions to provide a dynamic value.

   Conseil :

   Click This input supports Arcade Expressions and choose an ArcGIS Arcade expression to add it to its associated text box.

7. 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 Query Parameters (Paramètres de la requête).
   2. Indiquez une clé dans la zone de texte Key (Clé).

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

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

      You can also use ArcGIS Arcade expressions to provide a dynamic value.

   4. Laissez la case Enabled (Activé) cochée.
   5. Répétez les sous-étapes a à d pour ajouter davantage de paires clé-valeur.
8. 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.

9. Cliquez sur l’onglet Token (Jeton).
10. Cliquez sur le bouton bascule Test Mode (Mode test) dans la section Token (Jeton).
11. 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
    },
    "locations": [
      {
        "name": "380 New York Street",
        "extent": {
          "xmin": -117.196701,
          "ymin": 34.055489
        }
      }
    ]}

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

    Il s’agit du nom utilisé par le modèle de requête web pour référencer le jeton généré.

13. 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).

14. Cliquez sur Back (Retour) pour continuer à configurer la requête web.

Configurer les paramètres en sortie

Licence :

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

Le rôle ArcGIS Workflow Manager Server Advanced vous permet d’enregistrer la réponse de l’extrémité REST en tant que fichier, de joindre ce fichier au modèle et de le configurer en tant que valeurs en sortie personnalisées. Les valeurs en sortie peuvent être utilisées pour déterminer le chemin suivi par le workflow ou comme entrées d’autres étapes dans le workflow. Si aucune valeur en sortie n’est configurée pour le modèle, le code de statut HTTP est stocké en tant que valeur en sortie du modèle. Pour configurer les paramètres en sortie, procédez comme suit :

1. Cliquez sur l’onglet Sortie.
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 au modèle.
3. Si vous le souhaitez, effectuez les sous-étapes pour configurer le nom de la pièce jointe et le dossier dans lequel elle 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, effectuez les sous-étapes afin de configurer 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
      },
      "locations": [
        {
          "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 :

      $.locations.0.name

      Exemple d’expression JSONPath en notation par crochets :

      $['locations'][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 enregistrer les modifications.

Modifier des modèles de requête web

Pour modifier des modèles de requête web, procédez comme suit :

1. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Remarque :

   If you don't have sufficient privileges, the Design tab is not available.

3. Click Templates .

   Remarque :

   If you don’t have sufficient privileges, the Templates button is not available.

4. Click the Web Request tab.

   The Web Request panel appears.

   Remarque :

   If you don’t have sufficient privileges, the Web Request tab is not available.

5. Cliquez sur le nom de la requête web que vous souhaitez modifier dans le volet Web Request (Requête web).

   Conseil :

   Vous pouvez filtrer la liste des requêtes web dans le volet Web Request (Requête web) en saisissant un terme de recherche dans la zone de texte Search Web Request Templates (Rechercher des modèles de requête web).

6. Mettez la requête web à jour selon les besoins.
7. Cliquez sur Save (Enregistrer) pour enregistrer les modifications.

Supprimer des modèles de requête web

La suppression d’un modèle de requête web est définitive et ne peut pas être annulée. Pour supprimer des modèles de requête web, procédez comme suit :

1. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Remarque :

   If you don't have sufficient privileges, the Design tab is not available.

3. Click Templates .

   Remarque :

   If you don’t have sufficient privileges, the Templates button is not available.

4. Click the Web Request tab.

   The Web Request panel appears.

   Remarque :

   If you don’t have sufficient privileges, the Web Request tab is not available.

5. Cliquez sur le nom de la requête web que vous souhaitez supprimer dans le volet Web Request (Requête web).

   Conseil :

   Vous pouvez filtrer la liste des requêtes web dans le volet Web Request (Requête web) en saisissant un terme de recherche dans la zone de texte Search Web Request Templates (Rechercher des modèles de requête web).

6. Cliquez sur More Actions (Plus d’actions) puis sur Delete (Supprimer).

   Un message de confirmation apparaît.

7. Cliquez sur Yes (Oui) pour supprimer la requête web ou sur No (Non) pour annuler l’opération.