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

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. Si Workflow Manager dispose d’une licence pour le rôle ArcGIS Workflow Manager Server Advanced, 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 joindre ce dernier à la tâche. Les valeurs en sortie personnalisées peuvent être utilisées pour extraire les jetons des appels REST suivants, déterminer le chemin suivi par le workflow ou être utilisées en tant qu’entrées pour d’autres étapes du workflow.

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 le bouton Complete Step (Terminer l’étape) .

Configurer l’étape

To configure the step, do the following:

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. Create or edit a workflow diagram to access the Step Library panel.
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.

   Learn more about adding steps to a workflow diagram

   The Step Details panel appears.

3. Provide a name for the step in the Step Name text box.
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. Si vous avez ajouté des variables de chemin à l’URL, indiquez une valeur pour chaque variable dans la section Path Variables (Variables de chemin).
9. 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é).
   3. Indiquez une valeur dans la zone de texte Value (Valeur).
   4. Laissez la case Enabled (Activé) cochée.
   5. Répétez les sous-étapes a à d pour ajouter davantage de paires clé-valeur.
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. Pour sécuriser les informations, ajoutez un paramètre défini par l’utilisateur chiffré pour stocker ces informations et référencez-le dans l’étape à l’aide des propriétés de tâche dynamiques.

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é).
    3. Indiquez une valeur dans la zone de texte Value (Valeur).
    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 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 ArcGIS Workflow Manager Server Advanced, vous pouvez configurer les paramètres en sortie de l’étape.
15. Cliquez sur Save (Enregistrer) pour fermer la boîte de dialogue Configure Web Request (Configurer la requête Web).
16. Click the Options tab.
17. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.

      Remarque :

      If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

18. Optionally, provide help text for the step in the Step Help text box.

    You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

    'For further assistance, please contact ' + jobCreator($job) + '.'

19. Optionally, click the Style tab to change the shape and color of the step.
20. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    Remarque :

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

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 le joindre à la tâche 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 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, procédez comme indiqué ci-après 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 doit pas contenir de caractères spéciaux.

      Remarque :

      Si vous n’indiquez pas de nom, un dossier nommé General (Général) est créé automatiquement.

   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, procédez comme indiqué ci-après 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 fermer la boîte de dialogue Configure Web Request (Configurer la requête Web).

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

Valeur en sortie

Licence :

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

When the step is completed, its output value is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table shows the step's output value:

Sortie	Description	Syntaxe de l’expression ArcGIS Arcade
Statut	Renvoie le code de réponse HTTP si aucune valeur en sortie n’est configurée pour l’étape.	jobOutputValue($job, '<step_id>', 'Status')
<CustomOutputValue>	Renvoie la valeur en sortie personnalisée que vous avez configurée pour l’étape.	jobOutputValue($job, '<step_id>', '<custom_output_value_name>')