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) 
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) 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 :
- Créez ou mettez à jour un diagramme de processus pour accéder au volet Step Library (Bibliothèque d’étapes).
- 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.
- Spécifiez un nom pour l’étape dans la zone de texte Step Name (Nom de l’étape).
- 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).
Si l’invite utilisateur contient du texte brut et des expressions ArcGIS Arcade, mettez en forme le texte comme suit :
'This job is currently assigned to ' + JobOwner($Job) + '.'Conseil :
Cliquez sur This input supports Arcade Expressions (Cette entrée prend en charge les expressions Arcade)
et sélectionnez une expression Arcade pour l’ajouter à la zone de texte associée. - 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
- 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.
Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.
- 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.
Vous pouvez aussi utiliser des expressions ArcGIS Arcade pour fournir une valeur dynamique.
- 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.
- Cliquez sur Add New Parameter (Ajouter un nouveau paramètre).
- 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.
- Vous pouvez cliquer sur le bouton Show Default Value (Afficher la valeur par défaut)
pour définir la valeur par défaut du paramètre lorsque l’étape est exécutée.- 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.
- Indiquez une valeur par défaut pour la propriété dans la zone de texte Value (Valeur) ou Arcade Expression (Expression Arcade).
- Sélectionnez l’une des options suivantes :
- Répétez les étapes 9 à 11 pour ajouter d’autres paramètres.
- 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.
- 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.
- 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.
- Cliquez sur l'onglet Options.
- Définissez les paramètres Step Options (Options de l’étape) comme il convient :
- 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 le diagramme de processus est configuré pour exécuter automatiquement une séquence d’étapes qui comprend l’étape Exécuter un service de géotraitement, les étapes censées s’exécuter après l’expiration du jeton utilisateur ne démarrent pas automatiquement. L’extension d’organisation ArcGIS Workflow Manager Advanced est nécessaire à l’exécution des étapes automatisées supplémentaires sans intervention manuelle.
- Run on a Schedule (Exécution planifiée) : l’étape s’exécute selon une planification définie.
- Manual (Manuel) : l’étape est exécutée manuellement.
- Sélectionnez éventuellement l’une des options suivantes pour configurer l’aide dans l’étape :
- None (Aucune) : configurez l’étape sans son aide.
- Text (Texte) : configurez le texte de l’aide de l’étape dans la zone de texte Text (Texte).
Vous pouvez 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, mettez le texte en forme comme suit :
'For further assistance, please contact' + JobCreator($Job) + '.' - URL (URL) : configurez l’étape avec un lien vers une ressource d’aide dans la zone de texte URL (URL).
Remarque :
Les étapes qui sont exécutées dans l’application Web prennent en charge uniquement les formats d’URL HTTP et HTTPS. Les étapes qui sont exécutées dans ArcGIS Pro prennent en charge les formats d’URL HTTP et HTTPS ainsi que les formats de fichier.
Vous pouvez aussi utiliser des expressions Arcade pour fournir une valeur dynamique. Si l’URL contient du texte brut et des expressions Arcade, mettez le texte en forme comme suit :
'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'Configurez la case à cocher Automatically Encode Arcade Result (Encoder automatiquement le résultat Arcade) comme suit :
- Si une expression Arcade renvoie des caractères spéciaux à échapper lors de la conversion en URL, comme des espaces ou des barres obliques, assurez-vous que la case Automatically Encode Arcade Result (Encoder automatiquement le résultat Arcade) est cochée.
- Si une expression Arcade est utilisée pour constituer l’URL de base, décochez la case Automatically Encode Arcade Result (Encoder automatiquement le résultat Arcade).
- Cliquez éventuellement sur l’onglet Style pour changer la forme et la couleur de l’étape.
- 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).
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.
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 :
| Valeur de retour | Description |
|---|---|
| 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 :
| Sortie | Description |
|---|---|
<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
Vous avez un commentaire à formuler concernant cette rubrique ?