Ajouter et configurer une étape Run Pro GP Tool (Exécuter un outil de géotraitement Pro)

L’étape Run Pro GP Tool (Exécuter un outil de géotraitement Pro) exécute un outil de géotraitement configuré, un script Python ou un modèle ModelBuilder dans ArcGIS Pro.

Lorsque l’étape est exécutée, l’icône Starting (En cours de démarrage) Starting apparaît sur la vignette de la tâche. Pendant l’exécution de l’outil, l’icône Running (En cours d’exécution) Running apparait pour indiquer que l’outil est en cours d’exécution.

Si des paramètres d’étape sont configurés avec des expressions ArcGIS Arcade, ils sont convertis en valeurs appropriées avant le début de l’exécution de l’outil.

Si l’option Visible At Runtime (Visible à l’exécution) est activée, l’outil configuré dans l’étape s’ouvre dans la fenêtre Geoprocessing (Géotraitement) et vous permet de définir des valeurs de paramètre avant l’exécution de l’outil. Si des valeurs de paramètre par défaut ont été configurées, elles apparaissent lorsque vous exécutez l’étape et peuvent être remplacées. Si les valeurs User Prompt (Invite utilisateur) et Step Help (Aide de l’étape) ne sont pas configurées pour l’étape, celle-ci se termine automatiquement lors de son exécution.

Remarque :

Si une valeur de paramètre obtenue à partir d’une expression ArcGIS Arcade est incompatible avec l’outil, l’étape échoue.

Lorsque l’étape est exécutée, les actions suivantes peuvent être effectuées :

  • Si l’option Visible At Runtime (Visible à l’exécution) est activée, les valeurs de paramètre peuvent être indiquées et vous pouvez exécuter l’étape en cliquant sur Run (Exécuter) dans la fenêtre Geoprocessing (Géotraitement).
  • Pour annuler l’étape, cliquez sur Cancel (Annuler).
    Remarque :

    Dans certains cas, l’étape ne peut pas être annulée une fois que son exécution a commencé.

Configurer l’étape

Pour configurer l’étape, procédez comme suit :

  1. Créez ou mettez à jour un diagramme de processus pour accéder au volet Step Library (Bibliothèque d’étapes).
  2. Faites glisser Run Pro GP Tool (Exécuter un outil de géotraitement Pro) 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.

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

  3. Spécifiez un nom pour l’étape dans la zone de texte Step Name (Nom de l’étape).
  4. Ajoutez éventuellement le message que vous voulez faire apparaître lors de l’exécution de l’étape dans la zone de texte User Prompt (Invite utilisateur).

    Vous pouvez également vous servir de l’exemple suivant pour afficher une valeur dynamique à l’aide d’expressions ArcGIS Arcade.

    
    'This job is currently assigned to ' + jobOwner($job) + '.'
  5. Sélectionnez le type d’outil que vous souhaitez exécuter dans la section Arguments :
    • System Toolbox (Boîte à outils système) : outils de géotraitement inclus avec ArcGIS Pro et boîtes à outils importées dans un projet ArcGIS Pro.
    • Other Toolbox (Autre boîte à outils) : outils de géotraitement et scripts personnalisés
  6. Effectuez l'une des opérations suivantes :

    Outils des boîtes à outils système

    Saisissez l’alias de la boîte à outils qui contient l’outil que vous souhaitez exécuter dans la zone de texte Toolbox Alias (Alias de la boîte à outils).

    L’alias de la boîte à outils se trouve sur l’onglet Python de la page d’aide de l’outil dans la documentation ArcGIS Pro.

    Outils importés dans un projet ArcGIS Pro

    Saisissez l’alias de la boîte à outils qui contient l’outil que vous souhaitez exécuter dans la zone de texte Toolbox Alias (Alias de la boîte à outils).

    Cliquez avec le bouton droit sur la boîte à outils dans la fenêtre Catalog (Catalogue) et sélectionnez Properties (Propriétés) pour afficher son alias.

    Outils de géotraitement et scripts personnalisés

    Saisissez le chemin complet de la boîte à outils dans la zone de texte Toolbox Path (Chemin de la boîte à outils). Le chemin de la boîte à outils peut également référencer les boîtes à outils stockées dans une géodatabase fichier ou un géodatabase d’entreprise. Le chemin doit être accessible dans ArcGIS Pro.

  7. Saisissez le nom de l’outil à exécuter dans la zone de texte Tool Name (Nom de l’outil).

    Le nom de l’outil se trouve sur l’onglet Python de la page d’aide de l’outil dans la documentation ArcGIS Pro.

  8. Vous pouvez cocher la case Visible At Runtime (Visible à l’exécution) pour autoriser la définition des valeurs de paramètre lorsque l’étape est exécutée dans ArcGIS Pro.
  9. Cliquez sur Add New Parameter (Ajouter un nouveau paramètre).
  10. Saisissez le nom du paramètre dans la zone de texte Parameter Name (Nom du paramètre).

    Les noms de paramètre de l’outil se trouvent sur l’onglet Python de la page d’aide de l’outil de géotraitement dans la documentation ArcGIS Pro.

  11. Vous pouvez cliquer sur le bouton Show Default Value (Afficher la valeur par défaut) Show Default Value pour définir la valeur par défaut du paramètre lorsque l’étape est exécutée.
    1. Sélectionnez l’une des options suivantes :
      • Value (Valeur) : indiquez une valeur statique.
      • Arcade Expression (Expression Arcade) : indiquez une valeur dynamique à l’aide d’une expression Arcade.
    2. Indiquez une valeur par défaut pour la propriété dans la zone de texte Value (Valeur) ou Arcade Expression (Expression Arcade).
  12. Répétez les étapes 9 à 11 pour ajouter d’autres paramètres.
  13. Vous pouvez saisir le nom du paramètre en sortie dérivé si vous voulez l’utiliser en tant que valeur en sortie à la fin de l’exécution de l’outil.

    Les paramètres en sortie dérivés de l’outil se trouvent sur l’onglet Python de la page d’aide de l’outil dans la documentation ArcGIS Pro.

  14. Vous pouvez cocher la case Attach GP Log (Joindre le journal de géotraitement) pour enregistrer l’historique de l’outil en tant que pièce jointe de tâche.
  15. Si vous le souhaitez, saisissez le nom du dossier où seront stockées les journaux dans la zone de texte Folder (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.

  16. Cliquez sur l’onglet Options.
  17. 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 les étapes automatisées supplémentaires 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

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

    Vous pouvez également vous servir de l’exemple suivant pour afficher une valeur dynamique à l’aide d’expressions ArcGIS Arcade.

    
    'For further assistance, please contact ' + jobCreator($job) + '.'
  19. Cliquez éventuellement sur l’onglet Style pour changer la forme et la couleur de l’étape.
  20. Cliquez éventuellement sur l’onglet About (À propos de) et spécifiez une description pour l’étape dans la zone de texte Step Description (Description de l’étape).
    Remarque :

    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.

Valeur de retour

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 répertorie les valeurs de retour de l’étape :

Valeurs renvoyéesDescription

S000001

L’étape s’est terminée correctement.

F000001

L’étape ne s’est pas terminée correctement.

Valeur en sortie

Une fois que l’étape est 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 :

SortieDescriptionSyntaxe de l’expression ArcGIS Arcade

<DerivedOutputParameterValue>

Renvoie la valeur en sortie dérivée configurée reçue à partir de l’outil.

jobOutputValue($job, '<step_id>','<derived_output_parameter_name>')

Remarque :

derived_output_parameter_name est un paramètre facultatif. Si aucun nom de paramètre en sortie dérivé n’est fourni, la première valeur en sortie dérivée est renvoyée.

Rubriques connexes