Paramètres de l'outil web

Les paramètres que vous choisissez lors du partage d’un outil en tant qu’outil web définissent son mode de consommation par les applications client. Les paramètres les plus courants et les plus fréquemment modifiés d’un service peuvent être définis au cours du partage. Les paramètres moins courants peuvent être modifiés dans ArcGIS Server Manager, une fois l’outil partagé. Quelques paramètres avancés peuvent uniquement être définis sur la page Web ArcGIS Server Administrator. Peu d’outils Web (services de géotraitement) nécessiteront la modification de ces paramètres avancés.

Conseil :

Utilisez ArcGIS Server Manager pour administrer et modifier les paramètres de l’outil publié.

Paramètres

Les sous-sections ci-dessous décrivent les paramètres que vous pouvez utiliser lors du partage d’un outil Web.

Généralités

Paramètre	Description
Nom	Le nom de l'outil web à partager sur votre portail. Ce nom doit être unique sur votre portail et ne doit pas contenir d’espaces ou de caractères spéciaux. Ce paramètre est hérité des métadonnées de l’outil.
Résumé	Résumé et balises qui permettent de décrire le document et grâce auxquels l’outil web peut faire l’objet d’une recherche. Chaque paramètre hérite des métadonnées de l’outil. Ce paramètre hérite des métadonnées de l’outil. Le résumé et les balises sont requis en cas de partage sur un portail ArcGIS Enterprise 10.9 ou versions antérieures. Vous pouvez utiliser un maximum de 128 balises.
Balises
Version	Version du serveur ArcGIS Enterprise ou ArcGIS Server sur laquelle vous allez partager. Ce paramètre n’est activé que lorsque vous enregistrez une définition de service pour un outil web ou un service de géotraitement.
Données	Indique si les données sont copiées sur le serveur (deviennent statiques) ou si elles restent référencées par l’outil Web. Une entrée correspondante dans le data store du serveur doit être configurée pour que vos données utilisent le paramètre Reference registered data (Référencer les données enregistrées). Si le data store du serveur ne configure pas vos données, elles sont copiées lors de la publication. Cela s’applique uniquement lors de la publication en tant qu’outil Web ou lors de l’enregistrement sous la définition du service connecté. Si vous enregistrez le résultat en tant que définition de service hors ligne, veillez à ce que toutes les données de votre paramètre soit référencée si vous sélectionnez Reference data (Données de référence), car il n’y a pas d’alternative pour copier les données si le data store du serveur ne configure pas vos données.
Emplacement	Folder (Dossier) : sélectionnez ou créez un dossier de portail dans lequel l’outil web sera créé. Il s’agit par défaut de la racine du portail. Server and Folder (Serveur et dossier) : pour le serveur, les outils web doivent être partagés sur un portail doté d’un ou de plusieurs serveurs fédérés. Si votre portail possède plusieurs serveurs fédérés, vous pouvez choisir le serveur sur lequel l’outil Web sera publié. Pour le dossier, vous pouvez sélectionner un dossier existant ou créer un dossier sur le site ArcGIS Server. Il s’agit par défaut de la racine du site ArcGIS Server.
Partager avec	Indiquez les personnes et les groupes avec lesquels votre outil Web sera partagé. Un outil Web est toujours partagé dans My Content (Mon contenu). Lorsque vous partagez un outil Web avec Everyone (Tout le monde) celui-ci devient public. Toute personne accédant au site Web du portail peut le trouver et l’utiliser, et les propriétaires de groupes peuvent l’inclure au contenu de leur groupe. Si vous partagez un outil Web sur ArcGIS Enterprise, l’outil est partagé avec tous les membres de votre portail qui ont accès à un élément. Vous pouvez le partager avec tous les groupes auxquels vous appartenez actuellement.

Configuration

Paramètre	Description
Publier	Indique si un client peut charger un fichier sur votre serveur afin de l’utiliser en entrée de l’outil Web. L’opération de téléchargement est généralement utilisée par les clients Web qui ont besoin d’une solution pour envoyer un fichier au serveur pour traitement. Une fois le chargement terminé, un ID unique est renvoyé pour le fichier, ID que l'application web peut transmettre à l'outil web. Cette option est désactivée par défaut. Autoriser les chargements dans votre service peut comporter un risque de sécurité. Activez cette option uniquement si vous en avez besoin.
Mode d’exécution : Synchronous (Synchrone) ou Asynchronous (Asynchrone)	Les termes synchrone et asynchrone définissent la façon dont le client (l'application utilisant l'outil web) interagit avec l'outil web et génère la sortie. Lorsqu'un outil web est synchrone, le client attend la fin de la tâche. En général, un service synchrone s'exécute rapidement (en moins de quelques secondes). L’exécution d’un service asynchrone dure généralement plus longtemps et le client doit régulièrement demander au serveur si le service est terminé et, s’il est terminé, obtenir le résultat. Une application Web qui utilise un service asynchrone doit être dotée d’une logique qui vérifie l’état et gère le résultat une fois l’exécution terminée. Les clients ArcGIS Desktop gèrent les deux types d’exécution de manière native.
Afficher la sortie dans la couche d'images de carte	Lorsque vous publiez un outil Web, vous pouvez afficher la sortie en tant qu’image de carte. L’image de carte est créée sur le serveur et retransmise sur le client sous forme d’image (fichier .tiff, avec des informations de style). La symbologie, l’étiquetage, la transparence et les autres propriétés de l’image de la carte sont identiques à ceux de la couche en sortie de la session ArcGIS Pro lors de la publication d’origine. Vous pouvez utiliser l’option View output in map image layer (Afficher la sortie dans la couche d’images de carte) pour les raisons suivantes : Si l’outil génère un grand nombre d’entités que le client doit symboliser et dessiner, il est plus rapide pour le client de recevoir une image de carte. Pour des raisons de distribution des données, il est préférable de n’envoyer au client qu’une image de carte, et non des entités. Le résultat de l’outil est un jeu de données non transportable, tel qu’un réseau ou une topologie. L’image de carte constitue la seule façon d’envoyer la sortie au client. Remarque : Une image de carte en sortie peut uniquement être utilisée lorsque l’outil web est défini sur Asynchronous (Asynchrone). Ce paramètre n’est pas pris en charge lors de la publication d’un outil Web dans Kubernetes.
Niveau du message	Vous pouvez renvoyer des messages de niveaux différents au client qui a exécuté votre outil web, comme suit : None (Aucun) : cette option indique qu’aucun message de géotraitement n’est renvoyé au client, uniquement une indication de la réussite ou de l’échec de l’exécution. Il s’agit de l’option par défaut. Erreur : cette option indique que seuls les messages d'outil à l'origine d'une erreur sont renvoyés au client. Avertissement : cette option indique que tous les messages d'avertissement et d'erreur sont renvoyés au client. Info : cette option indique que tous les messages d'outil inhérents à l'exécution sont renvoyés au client. Attention : Tous les messages, quel que soit leur niveau, peuvent contenir des noms et des chemins d’accès au jeu de données, ce qui peut représenter un risque en termes de sécurité. Le niveau Info contient des références aux noms et chemins d'accès au jeu de données. En général, activez le renvoi des messages en phase de développement et désactivez-le en phase de production.
Nombre maximum d’enregistrements renvoyés	Nombre maximal de résultats que le service peut renvoyer à un client. Si cette valeur est définie sur un nombre élevé, cela signifie que votre serveur SIG peut gérer l’envoi de nombreux enregistrements individuels ou d’entités au client. Si vous ne souhaitez pas renvoyer d’entités, définissez cette valeur sur 0 (zéro). En règle générale, cette valeur est définie sur zéro uniquement lorsque vous activez l'option Afficher la sortie dans la couche d'images de carte.

Les paramètres mentionnés précédemment peuvent être modifiés dans ArcGIS Server Manager une fois l’outil web partagé, à l’exception du résumé et des balises. Ces informations de description peuvent être mises à jour sur la page de l'élément de l'outil web partagé sur votre portail.

Contenu

Les paramètres suivants peuvent uniquement être modifiés au moment de la publication d'un outil web.

Ajouter un outil

Pour ajouter des outils à partir de l’historique du géotraitement à l’outil Web existant, cliquez sur le bouton Add Tool (Ajouter un outil) sur l’onglet Content (Contenu). Pour supprimer des outils, cliquez sur le nom de l’outil et sélectionnez Remove (Supprimer).

Configurer les propriétés d’un outil

Vous pouvez modifier les propriétés d’un outil en cliquant sur le bouton de mise à jour situé à droite du nom de l’outil.

Paramètre	Description
Nom	Nom de l’outil. Ce nom est hérité de l’étiquette des métadonnées de l’outil.
Description	Description de l’outil. La description n’est pas héritée des métadonnées de l’outil. Si elle est vide, indiquez une description ; elle sera conservée à chaque fois que vous procéderez à un partage depuis l’historique.

Les propriétés suivantes peuvent être modifiées pour chaque paramètre :

Paramètre	Description
Nom	Nom et description du paramètre. Ils sont hérités du nom et de la description du paramètre dans les métadonnées de l’outil. Vous pouvez les modifier ici sans affecter les métadonnées d’origine de l’outil.
Description
Type	Le type de paramètre indique si le client doit fournir une valeur afin que l’outil s’exécute avec succès. L’onglet Content (Contenu) permet uniquement de modifier les paramètres facultatifs en paramètres obligatoires. Pour modifier un paramètre obligatoire en paramètre facultatif, quittez la fenêtre de partage, mettez à jour les propriétés de l’outil et exécutez à nouveau l’outil afin de créer un nouveau résultat.
Input Mode (Mode en entrée)	Le mode en entrée détermine la façon dont les clients indiquent des entités en entrée pour votre tâche : User defined value (Valeur définie par l’utilisateur) : le client fournit une valeur pour le paramètre. Choice list (Liste de choix) : le client se voit proposer une liste donnée de chaînes (la liste de choix) et doit en sélectionner une ou plusieurs dans la liste. En fonction du type de données de l’entrée, les chaînes peuvent être les noms des couches ou de simples options de mots-clés. Constant (Constante) : l’outil utilise la valeur que vous avez indiquée pour le paramètre lorsque vous avez créé le résultat. Puisque la valeur est constante, le client ne peut pas la modifier. Elle ne deviendra donc pas un paramètre de tâche à la publication du service.
Geometry Type (Type de géométrie) (s’applique uniquement à un jeu d’entités et à une couche d’entités).	Le type de géométrie découle des entités en entrée et en sortie utilisées pour créer le résultat. Il ne peut pas être modifié dans l’onglet Content (Contenu). Vous devez réexécuter l’outil à l’aide d’entités du type de géométrie souhaité, puis partager le résultat découlant de l’exécution.
Schema (Structure) (s’applique à un jeu d’entités, une couche d’entités, un jeu d’enregistrements et une vue tabulaire).	La structure est une liste de champs (attributs) qui doivent être fournis par le client lorsqu’il construit les entités à entrer pour l’outil. Cette liste de champs est la même que la couche ou le jeu de données utilisé en entrée ou sortie de l’outil ayant créé le résultat.
Valeur par défaut	La valeur par défaut de l’outil est déterminée par la valeur de paramètre indiquée lors de l’exécution de l’outil. Pour ajouter ou modifier la valeur par défaut d’un paramètre, vous devez exécuter à nouveau l’outil avec le paramètre correspondant.

Le paramètre suivant est uniquement applicable à la sortie du type de données d’entités.

Paramètre	Description
Sortie du service d’entités	Le paramètre en sortie facultatif qui permet aux utilisateurs d’enregistrer la sortie en tant que service d’entités lors de l’utilisation de l’outil Web. Ce paramètre est pris en charge uniquement lors de la publication en tant qu’outil Web. Publier vers un service de géotraitement sur un serveur autonome n’est pas pris en charge.

Paramètres Web Manager

Les paramètres des sous-sections suivantes peuvent uniquement être modifiés dans ArcGIS Server Web Manager. Les paramètres de configuration précédents peuvent également être modifiés dans Web Manager une fois le service publié.

Remarque :

La modification des paramètres suivants entraîne le redémarrage du service.

Paramètres

Paramètre	Description
Agrégat	La grappe hébergeant le service. Ce paramètre peut uniquement être modifié si ArcGIS Server fait partie d’une grappe.
Répertoires	Désigne les répertoires utilisés par le serveur pour écrire les fichiers lors de l’exécution d’un outil.

Fonctionnalités

Paramètre	Description
WPS	Active les fonctionnalités WPS des services de géotraitement, ce qui permet à d’autres clients de se connecter à des outils et de les utiliser via les protocoles standard OGC. Pour en savoir plus sur WPS

Groupage

Paramètre	Description
Number of instances (Nombre d’instances)	Le nombre minimum et maximum d'instances du service. Les valeurs par défaut sont 1 (minimum) et 2 (maximum). La définition d’une valeur minimum de 0 réduit les ressources système. Une instance démarre à la demande d’un client.
Durée maximale pendant laquelle un client peut utiliser un service	Durée maximale, exprimée en seconde, d'utilisation d'un service. Vous pouvez avoir besoin d'augmenter la valeur par défaut à 600 secondes (10 minutes) pour les tâches de géotraitement avec une durée d'exécution plus longue. Il peut aussi être nécessaire de réduire cette durée pour éviter qu'un client n'abuse de vos services.
The maximum time a client will wait to get a service (La durée maximale d'attente d'un client avant d'obtenir un service)	Période maximale, exprimée en seconde, durant laquelle un client doit attendre pour se connecter à une instance avant la période d’expiration. Lorsque toutes les instances sont occupées avec le traitement de demandes, les demandes sont placées dans une file d'attente. Si cette période d'expiration s'écoule avant qu'une instance ne soit disponible, la tâche échoue. La valeur par défaut est de 60 secondes (1 minute).
The maximum time an idle instance can be kept running (La durée maximale d'exécution d'une instance inactive)	Période maximale, exprimée en seconde, durant laquelle un client doit attendre pour se connecter à une instance avant la période d'expiration. Toutes les instances inutilisées au-delà du nombre minimal d’instances sont arrêtées dès que la période d’inactivité a atteint la valeur limite définie.

Processus

Paramètre	Description
Recyclage	Contrôle la fréquence de recyclage et quand recycler un service. La valeur par défaut est d’une fois toutes les 24 heures, à partir de minuit. Les services de géotraitement s'exécutent uniquement en isolement élevé, contrairement à certains autres types de service qui peuvent s'exécuter en isolement faible ou élevé.