Chaque tâche de géotraitement est associée à au moins un paramètre. Chaque paramètre de tâche possède un ensemble de propriétés descriptives qui vous aident à comprendre le paramètre et fournissent les valeurs appropriées à la bonne exécution de la tâche. La capture d'écran ci-dessous présente l'exemple du paramètre de tâche Distance, tel qu'affiché sur la page de la tâche de géotraitement dans le répertoire des services. La signification de chaque propriété est indiquée plus bas.
Type de données
Le type de données du paramètre indique le type de valeur que le client doit fournir pour le paramètre. La valeur du paramètre peut être très simple : long, double, booléen, date ou chaîne. Il peut également s'agir d'un jeu d'entités (une collection d'entités dont les attributs sont similaires au sein d'une classe d’entités), d'une table ou d'un raster. Par exemple, si le type de données est "long", vous devez fournir une valeur numérique comprise entre -2 147 483 648 et 2 147 483 64. Toute autre valeur décimale ou valeur de chaîne générera un comportement inattendu de l'outil. Pareillement, si le type de données est "raster", vous devez fournir les données raster appropriées pour exécuter l'outil avec succès. La liste ci-dessous répertorie les types de données d'un paramètre de tâche et ses valeurs attendues.
| Type de données | Valeur | Exemple de représentation JSON |
GPLong | Entier compris entre -2 147 483 648 et 2 147 483 647. | 345 |
GPDouble | Valeurs décimales | 1.414 |
GPString | Chaîne | TestString |
GPBoolean | true ou false | vrai |
GPLinearUnit | Valeur contenant une distance et son unité de mesure, telle que les pieds, les miles, les kilomètres, etc. | { "distance" : 345.678, "units" : "esriMiles" } |
GPDate | Nombre de millisecondes depuis l'époque (1er janvier 1970, UTC). | 1199145600000 |
GPDataFile | Tout type de fichier, tel que .txt, .pdf, .csv, etc. | { "url" : "http://myserver/myfile" } |
GPRasterDataLayer | Données raster consistant en une matrice de cellules (ou pixels) organisées en lignes et en colonnes (grille) dans laquelle chaque cellule contient une valeur représentant des informations. | { "url" : "http://myserver/lake.tif", "format" : "tif" } |
GPRecordSet | Tables représentées en colonnes et en lignes. |
|
GPFeatureRecordSetLayer | Entités disposant de définitions de géométrie, de champ et de référence spatiale et d'entités. | JSON GPFeatureRecordSetLayer |
GPMultiValue | Tableau de valeurs de paramètres de géotraitement de même type de données. Par exemple, GPMultiValue:GPString, GPMultiValue:GPLinearUnit |
["Parcels", "Street Lights"] [ { "distance" : 345.67, "units" : "esriMiles" }, { "distance" : 36, "units" : "esriMiles" } ] |
Remarque :
- Pour les paramètres GPRecordSet et GPFeatureRecordSetLayer, si vous devez traiter un gros volume d'enregistrements et d'entités, vous pouvez stocker la structure JSON dans un fichier et fournir l'URL comme entrée. Par exemple, { "url" : "http://myserver/myfeatures/afile.txt"}. Le fichier texte doit comporter un objet featureset ou recordset au format JSON.
- Si le type de données est GPMultiValue:GPFeatureRecordSetLayer, les objets featureset doivent être associés à des définitions de champ pour que l'exécution aboutisse.
Nom complet
Le nom d'affichage doit être pertinent pour le paramètre.
Direction
La direction permet d'identifier si le paramètre est en entrée ou en sortie.
- esriGPParameterDirectionInput : paramètre en entrée
- esriGPParameterDirectionInput : paramètre en sortie
Lorsqu'il exécute une tâche, le client doit uniquement fournir les valeurs des paramètres en entrée. Une fois la tâche exécutée avec succès, les paramètres en sortie sont créés par le serveur et le client peut alors accéder aux valeurs de ces paramètres.
Valeur par défaut
Lorsque vous publiez un service de géotraitement, les tâches de géotraitement sont créées à partir des résultats positifs de l'outil de géotraitement. La valeur par défaut contient les valeurs des paramètres du résultat à partir duquel la tâche a été créée. La valeur par défaut d'un paramètre en entrée constitue un exemple de la valeur du paramètre qui doit être transmise afin de garantir la bonne exécution de la tâche ; la valeur par défaut d'un paramètre en sortie constitue un exemple de la sortie attendue de la tâche.
- La valeur par défaut de GPFeatureRecordSet et GPRecordSet comporte des informations supplémentaires sur la structure des objets featureset/recordset. La structure inclut les valeurs GeometryType, HasZ, HasM, Référence spatiale, Champs et Entités. La capture d'écran ci-dessous constitue un exemple de structure de type de données GPFeatureRecordSet.
Le client doit fournir des objets featureset en entrée conformes à la structure définie par la valeur par défaut pour que l'exécution de l'outil aboutisse. La propriété Entités de la structure sera None dans la plupart des cas. Toutefois, si la tâche a été publiée avec l'option Inclure les entités, les entités incluses seront répertoriées dans la valeur par défaut.
- Les paramètres GPDataFile, GPRasterData et GPRasterDataLayer n'ont aucune valeur par défaut.
Type de paramètre
Il existe trois types de paramètre :
- esriParameterTypeRequired : ce paramètre est obligatoire au succès de l'exécution. Le client doit fournir une valeur pour le paramètre lorsqu'il exécute une opération sur la ressource de la tâche.
- esriParameterTypeOptional : ce paramètre est facultatif au succès de l'exécution.
- esriParameterTypeDerived : la valeur de ce paramètre est un paramètre en sortie dérivé d'autres paramètres en entrée. Le client n'a donc pas besoin de fournir une valeur.
Catégorie
Lorsqu'il y a de nombreux paramètres en entrée et en sortie, ceux-ci sont généralement regroupés dans des catégories spécifiques pour que le créateur de l'outil puisse plus facilement les identifier. La capture d'écran ci-dessous constitue un exemple de catégories de paramètres, telles qu'affichées dans la boîte de dialogue de l'outil ArcGIS for Desktop.
La catégorie indique si le paramètre appartient à une catégorie spécifique, telle que défini par le créateur de l'outil. La valeur de catégorie peut être utilisée pour concevoir des widgets pour les tâches de géotraitement.
Liste de choix
Certains paramètres GPString disposent d'une propriété de liste de choix supplémentaire. Une liste de choix est un ensemble de valeurs prédéfini établi par l'éditeur pour garantir la bonne exécution de l'outil. Le client doit alors choisir l'une des valeurs de la liste. La tâche échoue si le client fournit une valeur qui ne figure pas dans cette liste. La capture d'écran ci-dessous présente une liste de choix contenant les valeurs Street network, Bike network ou Walk network pour le paramètre GPString Transportation_mode_network. Lorsqu'une telle liste de choix est fournie, le client doit choisir l'une des valeurs de la liste pour garantir la bonne exécution de l'outil.
Rubriques connexes
Vous avez un commentaire à formuler concernant cette rubrique ?