Créer un outil de script

Un outil de script est un outil de géotraitement permettant d’exécuter un script ou un fichier exécutable. Les outils de script permettent d’exécuter ces scripts à l’aide d’un outil de géotraitement comme interface de votre script. Lorsque vous créez un outil de script, vous spécifiez les paramètres dont votre 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 est exécuté, les valeurs de paramètre sont transmises à votre script et utilisées par votre script.

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. Via ArcPy, votre script peut accéder à l’environnement de géotraitement d’ArcGIS qui offre des avantages, 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’un 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 sélectionnez 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

Généralités

L’onglet Généralités englobe les propriétés suivantes :

• Nom : nom d’identification unique interne utilisé par l’outil.
• Étiquette : nom affiché pour l’outil dans la boîte à outils et lorsque l’outil est ouvert sur la boîte de dialogue 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.
• 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 ces propriétés en saisissant 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 votre boîte à outils est une boîte héritée (.tbx), une propriété permet également de stocker le chemin du script d’exécution de l’outil relatif au fichier de la boîte à outils. Si votre 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 votre boîte à outils est ancienne (.tbx), les propriétés Résumé, Illustration et Icône ne sont pas prises en charge.

Paramètres

L’onglet Parameters (Paramètres) présente une table des propriétés de paramètre, dans laquelle une ligne correspond à un paramètre. La table est vide par défaut. Pour chaque paramètre, vous définissez un certain nombre de propriétés, telles que l’étiquette qui apparaît pour ce paramètre dans l’interface utilisateur, le type de données que le paramètre accepte et si le paramètre est facultatif ou obligatoire. Vous devez au moins définir 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	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 Couche d’entités, vous pouvez choisir une couche dans une carte active ou accéder à 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.
Catégorie	La saisie du nom d’une catégorie place le paramètre dans un groupe déroulant dans 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	Une valeur est automatiquement définie pour le paramètre à l’ouverture de 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. Ainsi, si l’environnement de géotraitement spécifié est défini, la valeur est utilisée par défaut pour le paramètre donné à l’ouverture de 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.

Exécution

La page Execution (Exécution) contient les propriétés liées au code d’exécution de l’outil de script ou le chemin d’accès à un fichier script Python ou R. La page contient également des options d’intégration et de protection par mot de passe du code d’exécution de l’outil de script, ou d’exportation du code d’exécution vers un nouveau fichier.

Vous pouvez choisir d’intégrer le code d’exécution dans la boîte à outils ou le lien vers un fichier script externe. Quel que soit l’emplacement du code d’exécution, la page contient un éditeur de code que vous pouvez utiliser pour modifier le code d’exécution. Vous pouvez également cliquer sur le bouton Open in Script Editor (Ouvrir dans un éditeur de script) pour ouvrir le code d’exécution dans un éditeur de script. Vous pouvez spécifier l’éditeur de script de votre choix dans Geoprocessing options (Options de géotraitement).

Validation

La page Validation affiche le code de validation de l’outil de script. La validation permet de personnaliser la manière dont les paramètres réagissent et interagissent avec les valeurs et les autres paramètres dans l’outil de script. Le code de validation est écrit en Python.

Le bloc de code ToolValidator Python permet de contrôler l’apparence, les comportements et les messages de votre outil de script. Vous pouvez modifier le code de validation directement dans l’é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 de votre choix qui est configuré dans Geoprocessing options (Options de géotraitement).

Environnements

La page Environnements affiche deux listes : Environnements pris en charge et 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.