Créer un outil de script

Un outil de script est un outil de géotraitement qui permet d’exécuter un script ou un type de fichier qui peut être exécuté. Les outils de script permettent d’exécuter ces scripts à l’aide d’un outil de géotraitement qui fait office d’interface pour le script. Lorsque vous créez un outil de script, vous spécifiez les paramètres dont le script a besoin pour s’exécuter. Les paramètres les plus courants sont les jeux de données en entrée et en sortie, les noms de champ et les chaînes choisies dans une liste. Lorsque l’outil de script s’exécute, les valeurs des paramètres sont transmises au script et utilisées par celui-ci.

La plupart des outils de script exécutent un script Python (.py) qui utilise ArcPy, un site-packagePython installé avec ArcGIS. ArcPy fournit l’accès à des outils de géotraitement ainsi qu’à des fonctions, classes et modules supplémentaires qui vous permettent de créer rapidement des processus simples ou complexes. Par l’intermédiaire d’ArcPy, un script peut accéder à l’environnement de géotraitement d’ArcGIS et aux avantages qu’il offre, tels que la projection à la volée, la prise en charge d’un ensemble de sélections, la validation des entrées, l’émission de messages d’erreur et l’enregistrement d’historique.

Les outils de script peuvent également exécuter un script R (.r) qui utilise la bibliothèque R arcgisbinding.

En savoir plus sur R-ArcGIS Bridge

Les outils de script sont créés dans une boîte à outils. Pour créer un outil de script, cliquez avec le bouton droit sur une boîte d’outils dans la fenêtre Catalog (Catalogue), puis cliquez sur New (Nouveau) > Script.

Propriétés

Lorsque vous créez un outil de script, la boîte de dialogue des propriétés de cet outil de script s’ouvre avec les onglets latéraux suivants :

• Généralités
• Paramètres
• Exécution
• Validation
• Environnements

Onglet Général

L’onglet General (Généralités) comprend les propriétés suivantes :

• Name (Nom) : nom d’identification unique interne de l’outil.
• Label (Étiquette) : nom de l’outil qui s’affiche dans la boîte à outils et lorsque l’outil est ouvert dans la boîte de dialogue de l’outil.
• Description : brève description de l’outil qui s’affiche lorsque vous passez le pointeur de la souris sur l’outil.
• Résumé : description de l’outil lorsque vous positionnez le curseur sur l’icône d’aide sur la boîte de dialogue Ouvrir l’outil.
• Illustration : image qui s’affiche avec le résumé d’outil lorsque vous positionnez le curseur sur l’icône d’aide sur la boîte de dialogue Ouvrir l’outil.
• Attributes (Attributs) :
  • Show banner that tool modifies the input data (Afficher une bannière indiquant que l’outil modifie les données en entrée) : activez cette option pour afficher une bannière dans la partie supérieure de la boîte de dialogue de l’outil pour indiquer que l’outil modifie les données en entrée.
  • Do not add tool outputs to map (Ne pas ajouter les sorties de l’outil à la carte) : activez cette option pour ajouter automatiquement le jeu de données en sortie de l’outil à une carte ouverte.

    Remarque :

    Si l’option de géotraitement Add output datasets to an open map (Ajouter des jeux de données en sortie à une carte ouverte) est également activée, l’attribut de propriété de l’outil est toujours respecté.

  • Show Enable Undo toggle (Afficher le bouton bascule Activer l’annulation) : activez cette option pour afficher le bouton bascule Enable Undo (Activer l’annulation) à côté du bouton Run (Exécuter) dans la boîte de dialogue de l’outil.
  • Show banner that tool consumes ArcGIS credits (Afficher une bannière indiquant que l’outil consomme des crédits ArcGIS) : activez cette option pour afficher une bannière dans la partie supérieure de la boîte de dialogue de l’outil si l’outil consomme des crédits.
• Icône : petite image qui s’affiche lorsque l’outil est ajouté au ruban, à la barre d’outils Accès rapide ou à la bibliothèque Analyse.

Vous pouvez modifier les propriétés en fournissant des valeurs dans la zone de texte ou en cliquant sur l’icône pour rechercher un nouveau fichier image à utiliser comme illustration ou icône.

Remarque :

Si la boîte à outils est une boîte à outils héritée (.tbx), une propriété permet également de stocker le chemin du script source de l’outil relatif au fichier de la boîte à outils. Si la boîte à outils est une boîte à outils ArcGIS (.atbx), ce comportement est géré différemment. Si le script réside dans le même répertoire que le fichier .atbx ou dans un dossier enfant dans lequel le fichier .atbx est stocké, un chemin relatif est préservé. Si le script et le fichier .atbx sont complètement séparés, un chemin absolu est préservé.

Remarque :

Si la boîte à outils est une boîte à outils héritée (.tbx), les propriétés Summary (Résumé), Illustration, Icon (Icône) et Attributes (Attributs) ne sont pas prises en charge.

Onglet Paramètres

L’onglet Parameters (Paramètres) contient un tableau de propriétés de paramètres, où chaque ligne représente un paramètre. La table est vide par défaut. Pour chaque paramètre, définissez plusieurs propriétés, telles que l’étiquette qui s’affiche dans la fenêtre Geoprocessing (Géotraitement), le type de données que le paramètre accepte et si le paramètre est facultatif ou obligatoire. Définissez au moins les propriétés de paramètres Label (Étiquette), Name (Nom), Data Type (Type de données), Type et Direction.

Propriété	Description
Etiqueter	Nom du paramètre affiché sur l’outil.
Nom	Nom du paramètre lorsque l’outil de script est appelé en tant que fonction depuis un script Python différent.
Type de données	Spécifie le type de données que le paramètre accepte. Ceci détermine le contrôle utilisé dans l’outil. Par exemple, si vous sélectionnez Feature Layer (Couche d’entités), vous pouvez sélectionner une couche dans une carte active ou rechercher une classe d’entités.
Type	Les paramètres peuvent être obligatoires ou facultatifs. Si le paramètre est obligatoire, il doit avoir une valeur. Sinon, l’outil ne s’exécute pas. Si le paramètre est facultatif, l’outil peut s’exécuter sans spécifier de valeur.
Itinéraire	Les paramètres peuvent être en entrée ou en sortie. Les paramètres en entrée représentent les données existantes à traiter ou les valeurs à utiliser au cours du traitement. Les paramètres en sortie représentent les données créées par l’outil ou les valeurs qui sont calculées.
Description	Aide du document sur chaque paramètre de l’outil, notamment des instructions, des informations et les types de données ou valeurs acceptables. Les descriptions de paramètres s’affichent dans la boîte de dialogue de l’outil lorsque vous positionnez le curseur sur le bouton Information (Informations) situé à côté de l’étiquette de chaque paramètre.
Catégorie	Le fait de fournir le nom d’une catégorie a pour effet de placer le paramètre dans un groupe déroulant de la boîte de dialogue de l’outil.
Filtrer	Les filtres permettent de limiter les types spécifiques d’un jeu de données, d’un fichier ou d’un champ ou encore des valeurs spécifiques ou des valeurs dans une plage qui constituent des entrées acceptables dans un outil. Vous pouvez par exemple filtrer un paramètre de classe d’entités de sorte que seules les classes d’entités ponctuelles soient acceptables. Vous pouvez également filtrer un paramètre de nombre de sorte que seules les valeurs comprises entre 1 et 10 soient acceptables.
Dépendance	Vous pouvez rendre un paramètre dépendant d’un autre. Par exemple, un paramètre de champ peut dépendre d’un paramètre de jeu de données. Cette dépendance vous permet de sélectionner un champ dans le jeu de données dépendant.
Par défaut	Valeur automatiquement définie pour le paramètre au moment où apparaît la boîte de dialogue de l’outil.
Environnement	Un paramètre peut déduire sa valeur par défaut d’un environnement de géotraitement. Lorsque l’environnement de géotraitement spécifié est défini, la valeur est utilisée par défaut pour le paramètre en question au moment où apparaît la boîte de dialogue de l’outil.
Symbologie	Le chemin d’accès à un fichier de couche qui définit la symbologie du paramètre. Vous pouvez par exemple faire en sorte qu’un paramètre de jeu de données en sortie ait la même symbologie que celle du fichier de couche lorsque la sortie est créée et ajoutée à la carte.

Onglet Execution (Exécution)

L’onglet Execution (Exécution) comporte des propriétés liées au code source de l’outil de script ou le chemin d’accès à un fichier de script Python ou R. L’onglet comporte également des options permettant d’intégrer et de protéger par mot de passe le code source de l’outil de script, ou encore d’exporter le code source dans un nouveau fichier.

Vous pouvez intégrer le code source dans la boîte à outils ou un lien vers un fichier de script externe. Quel que soit l’emplacement du code source, l’onglet comporte un éditeur de code dont vous pouvez vous servir pour modifier le code. Vous pouvez également cliquer sur le bouton Open in Script Editor (Ouvrir dans un éditeur de script) pour ouvrir le code dans un éditeur de script. Vous pouvez spécifier l’éditeur de script de votre choix dans les options de géotraitement.

Onglet Validation

L’onglet Validation affiche le code de validation de l’outil de script. La validation permet de personnaliser la manière dont les paramètres de l’outil répondent aux valeurs et aux autres paramètres de l’outil de script et comment ils interagissent entre eux. Le code de validation est écrit en Python.

Le bloc de code Python ToolValidator permet de contrôler l’apparence, les comportements et les messages de l’outil de script. Vous pouvez modifier le code de validation directement à patir d’un éditeur de code ou cliquer sur le bouton Open in Script Editor (Ouvrir dans un éditeur de script) pour ouvrir le code de validation dans l’éditeur de script votre choix, ce que vous pouvez définir dans la boîte de dialogue des options de géotraitement.

Onglet Environments (Environnements)

L’onglet Environnements affiche les listes Supported Environments (Environnements pris en charge) et Unsupported Environments (Environnements non pris en charge). Vous pouvez ajouter ou supprimer des environnements entre ces listes. Seuls les environnements de la liste Environnements pris en charge s’afficheront sur l’onglet Environnements de la boîte de dialogue de l’outil de script.