Paramètres de l’outil Web et du service de géotraitement

Lors du partage d’un outil en tant qu’outil Web ou d’un service de géotraitement, les paramètres de propriété 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 l’API REST administrateur de ArcGIS Server.

Paramètres

Les sous-sections ci-après décrivent les paramètres disponibles pour le partage d’un outil Web ou d’un service de géotraitement.

Généralités

Les valeurs suivantes peuvent être utilisées pour les paramètres généraux :

Paramètre	Description
Nom	Nom de l’outil Web ou du service de géotraitement qui sera partagé sur le portail. Ce nom doit être unique sur le portail et ne peut contenir ni espaces ni 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. Les valeurs de ces paramètres sont héritées des métadonnées de l’outil. Vous pouvez utiliser le menu déroulant Tags (Balises) pour sélectionner des balises existantes. La limite maximale est de 128 balises.
Balises
Catégorie	Catégorie de l’élément d’outil Web. Ce paramètre n’est pas disponible pour les services de géotraitement publiés sur un site ArcGIS Server autonome.
Version	Version d’ArcGIS Enterprise ou d’ArcGIS Server sur laquelle l’outil sera partagé. Ce paramètre est activé uniquement pour l’enregistrement d’une définition de service hors connexion pour un outil Web.
Données	Spécifie le traitement qui sera appliqué aux données. Non-URL Data (Donnés ne provenant pas d’URL) : contrôle 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 les données utilisent l’option Reference registered data (Référencer les données enregistrées). Si le data store du serveur ne configure pas les données, celles-ci seront copiées lors de la publication. Cela s’applique uniquement lors de la publication en tant qu’outil Web ou lors de l’enregistrement en tant que définition de service connecté. Lors de l’enregistrement du résultat en tant que définition de service hors connexion, veillez à ce que toutes les données du paramètre puissent être référencées lorsque vous utilisez l’option Reference data (Données de référence), car il n’y a pas d’autre moyen de copier les données si le data store du serveur ne les configure pas. URL Data (Données d’URL) : contrôle si les données restent sous forme d’une URL ou si elles sont converties en un autre type de données pendant la publication. Cette option est disponible dans ArcGIS Pro 3.2 ou version ultérieure. Les données URL font référence à l’URL des différents types de couches Web ou services. Seuls les couches d’entités, les services d’entités ou les sous-couches d’entités des couches d’images Web peuvent être configurés. Lorsque l’option Convert feature layer (Convertir la couche d’entités) est sélectionnée, la couche ou le service d’entités du paramètre ou des données du projet est convertie en classe d’entités pendant la publication. Lorsque l’option n’est pas sélectionnée, l’URL de la couche d’entités est conservée. Aucune option ne permet de convertir l’URL des couches d’images Web car une URL est toujours conservée lors de la publication. Cette option est activée par défaut. En savoir plus sur la copie, le référencement et l’utilisation des données d’URL
Emplacement	Indique où l’élément d’outil Web ou le service de géotraitement sera créé. Pour les éléments d’outil Web publiés dans ArcGIS Enterprise, les options sont les suivantes : 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 le portail est doté de plusieurs serveurs fédérés, choisissez le serveur sur lequel l’outil Web sera publié. Pour le dossier, sélectionnez un dossier existant ou créez-en un sur le site ArcGIS Server. Il s’agit par défaut du dossier racine du site ArcGIS Server. Pour les services de géotraitement publiés sur des sites ArcGIS Server autonomes, l’option est la suivante : Folder (Dossier) : sélectionnez ou créez un dossier de serveur dans lequel l’élément de service de géotraitement sera créé. Il s’agit par défaut du dossier racine du serveur.
Partager avec	Disponible pour les outils Web publiés dans ArcGIS Enterprise uniquement, cette option permet d’indiquer avec quelles personnes et quels groupes l’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. Lorsque vous partagez un outil Web dans ArcGIS Enterprise, il est partagé avec tous les membres du portail qui ont accès à un élément. Vous pouvez le partager avec tous les groupes auxquels vous appartenez.

Configuration

Les valeurs de paramètres suivantes sont disponibles dans l’onglet Configure service capabilities and parameters (Configurer les fonctionnalités et paramètres du service) :

Paramètre	Description
Publier	Détermine si un client peut charger un fichier sur le 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 le service peut constituer un risque en matière de sécurité. Activez cette option uniquement si vous en avez besoin.
Mode d’exécution	Définit 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 défini sur Synchronous (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). Lorsqu’il est défini sur Asynchronous (Asynchrone), l’exécution du service prend généralement plus de temps, et le client doit régulièrement interroger le serveur pour savoir si le service a terminé la tâche et, si c’est le cas, 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. Le mode par défaut est Asynchronous (Asynchrone).
Afficher la sortie dans la couche d’images de carte	Lorsque vous publiez un outil Web ou un service de géotraitement, 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). Les propriétés de symbologie, d’étiquetage et de transparence, entres autres, de l’image de la carte sont identiques à celles de la couche en sortie de la session ArcGIS Pro lors de sa publication d’origine. Lorsque vous utilisez ce paramètre, tenez compte de ce qui suit : 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 le paramètre Execution mode (Mode d’exécution) de 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 sur Kubernetes. Cette option est désactivée par défaut.
Niveau du message	Renvoyez des messages des niveaux suivants au client qui a exécuté l’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’opération. 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’opération sont renvoyés au client. Attention : Tout message, quel que soit son niveau, peut contenir des noms de jeu de données et les chemins d’accès correspondants, ce qui peut représenter un risque en matière de sécurité. Le niveau Info est détaillé et contient habituellement des références aux noms des jeux de données et aux chemins d’accès correspondants. En général, renvoyez les messages de niveau Info ou Warning (Avertissement) dans un environnement de développement et de test, et utilisez le niveau None (Aucun) ou Error (Erreur) dans un environnement de production. La valeur par défaut est Aucun.
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 le serveur SIG peut gérer l’envoi de nombreux enregistrements individuels ou d’entités au client. Pour ne renvoyer aucune entité, définissez cette valeur sur 0 (zéro). Cette propriété n’a aucun effet lorsque le paramètre Add optional output feature service parameter (Ajouter un paramètre de service d’entités en sortie facultatif) est activé. La valeur par défaut est 1 000.

Les valeurs de paramètres suivantes sont disponibles dans l’onglet Configure Pooling (Configurer le groupage). Consultez la rubrique Optimiser et configurer des services pour en savoir plus sur les points à prendre en considération lors de la définition de ces paramètres.

Paramètre	Description
Number of instances (Nombre d’instances)	Nombre minimal et maximal d’instances du service de géotraitement qui peuvent être exécutées simultanément sur chaque machine serveur pour ArcGIS Enterprise ou le pod gp-server-sync pour ArcGIS Enterprise on Kubernetes.
Délais d’expiration du service – Temps d’utilisation maximal	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. Vous pouvez également réduire cette durée pour éviter qu’un client n’abuse de vos services.
Délais d’expiration du service – Temps d’attente maximal	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 le temps d’attente s’écoule avant qu’une instance devienne disponible, la tâche échoue. La valeur par défaut est de 60 secondes (1 minute).
Délais d’expiration du service – Durée d’inactivité maximale	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.

Les paramètres décrits ci-dessus 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 le portail.

Contenu

Les paramètres décrits ci-après peuvent uniquement être modifiés au moment de la publication d’un outil Web ou d’un service de géotraitement.

Ajouter un outil

Pour ajouter des outils à un outil Web ou service de géotraitement existant à partir de l’historique du géotraitement, cliquez sur le bouton Add Tool (Ajouter un outil)  de 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

Pour configurer les propriétés de l’outil, cliquez sur le bouton d’édition en regard du nom de l’outil.

Propriété	Description
Nom	Nom de l’outil. La valeur par défaut est basée sur les 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 partage depuis l’historique.

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

Propriété	Description
Nom	Nom et description du paramètre. Ces deux propriétés héritent du nom du paramètre et de la description des métadonnées de l’outil. La modification de ces propriétés est sans incidence sur les métadonnées de l’outil d’origine.
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. Dans l’onglet Content (Contenu), seuls les paramètres facultatifs peuvent être changés 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.
Conserver le type de données en tant que Composite	Cette propriété n’est disponible que lorsque le paramètre est un type de données composite. Détermine si le paramètre sera publié en tant que type de données composite (case cochée). Cette option est désactivée par défaut.
Input Mode (Mode en entrée)	Détermine de quelle façon les clients entreront des entités dans la tâche. Pour plus d’informations sur la conception et l’utilisation de l’interface utilisateur graphique, consultez la rubrique Mode en entrée. 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 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) : la valeur indiquée pour le paramètre lors de la création du résultat sera utilisée. 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. Mode mixte : valeurs définies par l’utilisateur et liste de choix : disponible uniquement pour les paramètres composites ou les paramètres de table de valeurs. Configurez le mode en entrée pour chaque type de données dans les données composites, ou chaque type de données pour chaque colonne dans la table de valeurs. Si un type de données ne prend pas en charge la liste de choix, seule l’option User defined value (Valeur définie par l’utilisateur) est disponible pour la configuration.
Convertir le type de données en Chaîne	Cette propriété ne s’applique qu’au type de données Unité surfacique. Cela indique si l’unité surfacique sera convertie en type de données Chaîne (case cochée) ou publiée en tant qu’unité surfacique (case non cochée). Cette option est désactivée par défaut.
Supprimer la valeur par défaut	À partir de ArcGIS Pro 3.3, lorsque cette case est cochée, la valeur par défaut utilisée lorsque l’outil est exécuté sera supprimée pendant le processus de publication. Cette option est désactivée par défaut.
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.
Utiliser uniquement les couches par défaut	Cette propriété ne s’applique qu’au mode en entrée des listes de choix. Cela spécifie si seules les options utilisées pendant l’exécution de l’outil seront cochées dans la vue de liste sous cette case de sélection (case cochée). Cette option est désactivée par défaut.
Type de géométrie	Cette propriété s’applique uniquement aux 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). Réexécutez l’outil à l’aide d’entités du type de géométrie spécifié, puis partagez le résultat obtenu par cette opération.
Structure	Cette propriété s’applique uniquement aux entités et aux tables. 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.

Les paramètres de configuration suivants s’appliquent à la totalité de l’outil :

Paramètre	Description
Ajouter un paramètre de service d’entités en sortie facultatif	Un paramètre en entrée facultatif qui indique si toutes les sorties d’entité peuvent être enregistrées en tant que service d’entités hébergé lors de l’utilisation de l’outil Web. Ce paramètre est uniquement pris en charge lors de la publication en tant qu’outil Web avec mode d’exécution asynchrone dans ArcGIS Enterprise. Il ne peut pas être utilisé pour la configuration en dehors de cela. Ce paramètre est sélectionné par défaut. En savoir plus sur l’utilisation des outils Web avec un service d’entités en sortie.
Ajouter le paramètre facultatif Service d’imagerie en sortie	Un paramètre en entrée facultatif qui indique si toutes les sorties raster peuvent être enregistrées en tant que services d’imagerie lors de l’utilisation d’un outil Web ou d’un service de géotraitement. En savoir plus sur l’utilisation des outils Web et des services de géotraitement avec service d’imagerie en sortie
Supprimer toutes les valeurs par défaut	À compter de ArcGIS Pro 3.3, lorsque cette case est cochée, toutes les valeurs par défaut utilisées lorsque l’outil est exécuté seront supprimées, et l’option Remove default value (Supprimer la valeur par défaut) dans la configuration du paramètre de l’outil ci-dessus sera automatiquement sélectionnée. Cette option est désactivée par défaut.

Paramètres de ArcGIS Server Manager

Les valeurs de paramètres présentées dans les sous-sections ci-après peuvent uniquement être modifiées dans ArcGIS Server Manager, mis à part ArcGIS Enterprise Manager pour ArcGIS Enterprise on Kubernetes. La plupart des paramètres de configuration décrits ci-dessus peuvent également être modifiés dans ArcGIS Server Manager une fois le service publié.

Remarque :

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

Paramètres

Les valeurs suivantes des paramètres sont disponibles :

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	Les répertoires utilisés par le serveur pour écrire les fichiers lors de l’exécution de l’outil.

Fonctionnalités

La valeur suivante du paramètre Fonctionnalités est disponible :

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

Processus

La valeur suivante du paramètre Processus est disponible :

Paramètre	Description
Recyclage	Contrôle à quelle fréquence et à quel moment un service est recyclé. 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é.