Skip To Content

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

When the step is run, the following actions can be performed:

  • 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

To configure the step, do the following:

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

    The Step Details panel appears.

  3. Provide a name for the step in the Step Name text box.
  4. Optionally, add the message you want to appear when the step is run in the User Prompt text box.

    If the user prompt contains plain text and Arcade expressions, you'll need to format the text as follows:

    'This job is currently assigned to ' + JobOwner($Job) + '.'
    Conseil :

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

  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.

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

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

    Si le nom de l’outil de géotraitement dans la zone de texte Tool Name (Nom de l’outil) correspond au nom d’une fonction Arcade, comme Zone tampon ou Découper, vous devez placer le nom de l’outil entre des guillemets simples ou doubles de manière à ce qu’il ne soit pas évalué comme une expression Arcade.

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

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

  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.
    Remarque :

    Lorsque la case Attach GP Log (Joindre le journal de géotraitement) est cochée, l’ID de pièce jointe du journal d’historique de l’outil est inclus dans les valeurs en sortie de l’étape.

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

  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 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 ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, you'll need to format the text as follows:

    
    '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.
    Conseil :

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output. Click Copy Step ID Copy Step ID to copy the step ID to your clipboard.

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 valueDescription

S000001

The step completed successfully.

F000001

The step failed to complete successfully.

Valeur en sortie

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

SortieDescription

<DerivedOutputParameterValue>

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

attachmentId

Renvoie une matrice des ID de pièce jointe ajoutés à l’étape.

Rubriques connexes