Présentation rapide de la création et du partage des outils web

La création d'un outil web implique un processus de création et de partage. Le processus de création commence par la génération d’un modèle ou d’un outil de script Python dans ArcGIS Pro. Une fois que vous avez créé et exécuté votre outil avec succès, vous pouvez le partager sur le portail ArcGIS Enterprise en tant qu’outil Web. Certains paramètres d'outils, données et autorisations de partage doivent être pris en compte lors du processus de création et de partage. Certains de ces points à prendre en compte sont soulignés dans l'exemple suivant et dans les sections appropriées de cette rubrique. Le workflow suivant décrit le processus global :

  1. Générez un script ou un modèle à l'aide des outils de la boîte à outils pour construire votre workflow.
  2. Rassemblez les jeux de données dont votre outil a besoin et rendez-les accessibles dans une géodatabase ou ajoutez-les à la carte dans votre projet.
  3. Exécutez l'outil pour créer une entrée dans l'historique du géotraitement.
  4. Définissez la symbologie des jeux de données en sortie dans votre carte, le cas échéant.
  5. Partagez l'élément d'historique en tant qu'outil web. Lorsque vous partagez votre outil web, vous pouvez définir les propriétés de l'outil et du service.

Exemple : examiner l'impact sur la population d'un pipeline proposé

L'outil de modèle suivant est un ensemble d'outils qui examinent la manière dont les gens risquent d'être impactés en cas de fuite d'un pipeline. Le workflow détecte les points d'intersection entre le pipeline et la rivière et effectue un parcours en aval pour identifier le nombre de personnes qui risquent d'être impactées. Ce modèle est configuré avec des données de projet et des paramètres et est publié en tant qu'outil web. Un analyste ou le grand public peut modifier le parcours suggéré du pipeline pour examiner l'impact probable d'une fuite sur la population en aval. Les résultats de l'outil web illustrent le point où le pipeline traverse la rivière et offrent un résumé de la population impactée.

Modèle permettant d'effectuer une analyse sur la population impactée pour un pipeline

Conception des outils

Tous les outils utiles disposent de paramètres en entrée et en sortie. Ces paramètres permettent aux utilisateurs de fournir des valeurs différentes à chaque exécution de l'outil, ce qui permet à l'outil de produire des analyses différentes. Outre les paramètres en entrée et en sortie, les outils possèdent généralement des données de projet et des données intermédiaires. Il s'agit de jeux de données sur lesquels la personne qui exécute l'outil n'a généralement aucun contrôle. Dans un modèle, les paramètres en entrée sont signalés par un P. Lorsque le modèle est exécuté en tant qu'outil, les entrées avec un P sont disponibles dans la boîte de dialogue de l'outil pour définir une valeur à utiliser lors de l'exécution de l'outil. Dans le modèle du pipeline, l'utilisateur peut spécifier le chemin d'accès au pipeline et une distance de bufférisation lors du parcours en aval. Lorsqu'une personne utilise cet outil, l'emplacement du pipeline et la taille de la zone tampon changent pour afficher le nombre de personnes finalement impactées par le pipeline. Les intersections du pipeline et la ligne de parcours dans cet exemple sont des jeux de données intermédiaires que l'outil de modèle produit au cours de l'exécution. Ces jeux de données intermédiaires ne sont pas requis par la personne qui exécute l'outil et ils ne sont pas renvoyés comme résultat. Lorsque ce modèle est partagé, le service de géotraitement sous-jacent qui optimise l'outil web gère l'endroit où les données intermédiaires sont écrites et les nettoie finalement lorsqu'elles deviennent inutiles.

Paramètres en entrée de l'outil de modèle

Tout comme les paramètres en entrée sont importants pour tous les outils réussis, les paramètres en sortie sont également importants. Le paramètre en sortie permet à l'outil de renvoyer un résultat à la personne qui l'exécute. Dans ArcGIS Pro, les paramètres en sortie sont importants, car ces jeux de données sont automatiquement ajoutés à la carte. Un outil sans paramètre en sortie génère une sortie, mais n'affiche pas automatiquement ces informations. Les outils web fonctionnent à peu près de la même manière : un ou plusieurs paramètres en sortie sont nécessaires pour renvoyer le résultat à l'utilisateur final. Dans le modèle du pipeline, deux paramètres en sortie sont présents : la population des zones impactées qui illustre les emplacements de zone tampon en aval et la table de synthèse de la population avec le résumé de l'intégralité de la population impactée. Notez que la population des zones impactées représente à la fois des données intermédiaires et en sortie. Ce paramètre est intermédiaire, car il est requis par l'outil Résumés statistiques, mais il a été défini comme paramètre de modèle (P) et ce résultat sera renvoyé au client au terme de l'exécution de l'outil.

Paramètres en sortie de l'outil de modèle
Astuce :

Les mêmes principes des paramètres en entrée et en sortie, des données de projet et des données intermédiaires de l'outil s'appliquent à la création des outils de scriptScript.

Documenter l'outil

Fournir une bonne documentation pour votre outil web est essentiel si vous voulez que votre outil soit découvert, compris et utilisé par un large public. Une bonne documentation commence par l'outil d'origine. Vous pouvez fournir le même type de métadonnées pour votre modèle ou outil de script qu'un outil système.

Pour en savoir plus sur la documentation des outils

Exécuter l'outil

Une fois l'outil créé, vous devez l'exécuter. L'exécution de l'outil génère une entrée dans l'historique du géotraitement. Il n'est pas possible de partager l'exécution d'un outil qui a échoué.

Remarque :

L'exécution d'un modèle dans ModelBuilder ne génère pas d'entrée dans l'historique du géotraitement. Les outils de modèle doivent s'exécuter en tant qu'outil dans la fenêtre Géotraitement.

Partager votre outil web

Il est possible de partager l’outil Web en sélectionnant Analysis (Analyse) > History (Historique) pour ouvrir la fenêtre History (Historique). Pour partager, cliquez avec le bouton droit sur un élément à partager et sélectionnez Share As (Partager en tant que). Pour procéder au partage en tant que nouvel outil Web, sélectionnez Share Web Tool (Partager l’outil Web) afin d’ouvrir la fenêtre Share As Web Tool (Partager en tant qu’outil Web). Pour remplacer un outil existant, sélectionnez Overwrite Web Tool (Remplacer l’outil Web) pour ouvrir une fenêtre comportant tous les outils Web existants publiés dans My Content (Mon contenu).

Fenêtre de sélection Overwrite Web Tool (Remplacer l’outil Web)

Veillez à sélectionner l’outil correct à remplacer et cliquez sur OK pour ouvrir la fenêtre Overwrite Web Tool (Remplacer l’outil Web). Les traitements des configurations d’outil Web prépubliées sont identiques pour les options Share Web Tool (Partager l’outil Web) et Overwrite Web Tool (Remplacer l’outil Web), comme indiqué ci-dessous.

Vous pouvez aussi accéder à Share (Partager) > Web Tool (Outil Web) pour sélectionner Share Web Tool (Partager l’outil Web) ou Overwrite Web Tool (Remplacer l’outil Web). Si vous sélectionnez l’option Share Web Tool (Partager l’outil Web), sélectionnez un élément à partir d’une fenêtre de partage d’outil dont tous les éléments ont été exécutés avec succès.

Fenêtre Select Tool To Share (Sélectionner l’outil à partager)

Si vous sélectionnez l’option Overwrite Web Tool (Remplacer l’outil Web), sélectionnez un élément à remplacer dans la fenêtre contenant tous les outils Web existants que vous avez publiés dans My Content (Mon contenu). Sélectionnez ensuite un élément dans la fenêtre comportant tous les éléments exécutés avec succès avec lesquels vous souhaitez procéder au remplacement. Les étapes de remplacement de ce processus sont inversées si vous effectuez votre sélection depuis Analysis (Analyse) > History (Historique).

Définir les propriétés de l'outil web

L'outil d'évaluation des fuites génère des entités et une table. La quantité de données que cet outil génère et renvoie étant limitée en taille, l'outil web sera configuré en tant que service asynchrone sans service de carte généré. Un paramètre par défaut de 1 000 enregistrements au maximum est suffisant. Un niveau de message erreur permet de s'assurer que seuls les messages concernant un échec possible de l'outil sont renvoyés. En cas de réussite de l'exécution de l'outil web, les messages de traitement normaux ne sont pas renvoyés à l'utilisateur final.

Options de configuration de l'outil web

Un outil web est toujours accessible dans votre fenêtre Mon contenu. Vous pouvez partager votre outil avec votre organisation, avec tout le monde ou avec certains groupes. L'outil d'évaluation des fuites est idéal à partager avec des parties prenantes précises de l'organisation, qui doivent effectuer une analyse du pipeline. La sélection des groupes appropriés permettra à ces utilisateurs de trouver et d'utiliser rapidement l'outil.

Options de partage de l'outil web

Copier ou référencer les données

Tous les outils web utilisent des données en entrée ou des données de projet. Lorsque vous partagez le modèle d'évaluation des fuites en tant qu'outil web, il accepte les données d'un utilisateur et les traitent en s'appuyant sur les données de projet référencées dans le modèle. A ce stade de partage de l'outil, vous devez choisir entre copier les données sur le serveur, générer une copie statique des données que le service utilisera ou créer une référence à laquelle le serveur peut accéder. Dans ce workflow en particulier, les données de projet comprennent les jeux de données de rivière et de population qui sont statiques, c'est-à-dire qu'ils sont rarement mis à jour. Dans ce cas précis, il est judicieux de copier les données sur le serveur. Ce processus collecte et convertit les données (le cas échéant) en classes d'entités de géodatabase fichier où elles seront extraites sur le serveur et utilisées par le service.

Regardez si la méthode d'analyse a été légèrement modifiée lorsque l'utilisateur n'a pas proposé son propre pipeline. Les autres propositions de pipeline proviennent d'un autre processus et l'utilisateur a fournit des entrées différentes dans l'outil. Dans ce cas, le pipeline proposé se transforme en données de projet. Par conséquent, il est conseillé de placer ce jeu de données dans une géodatabase d'entreprise et de faire en sorte que l'outil y fasse référence. Lors de la publication, vous définissez une référence aux données à l'aide du stockage des données ArcGIS Server. Le processus de publication gère la référence à la base de données au lieu de générer une copie statique. Un analyste du projet peut ultérieurement mettre à jour les données dans la géodatabase d'entreprise et l'outil web effectue l'analyse sur la dernière proposition de pipeline.

Options des données de l'outil web

Analyser

Le processus Analyze (Analyser) Analyse de partage d’un outil Web permet de s’assurer que vous êtes en mesure de réussir la publication de l’outil sur votre portail. En outre, des messages d'avertissement concernant les données risquent d'apparaître et vous pouvez prendre les mesures que vous jugez nécessaires. Le stockage des données est déjà configuré dans l'outil d'évaluation des fuites, l'outil est documenté et il utilise des outils pris en charge qui fonctionnent dans un outil web, de sorte qu'aucun avertissement ou message n'apparaîtra.

Publier

Une fois les propriétés de l'outil web configurées et les erreurs de l'analyseur résolues, publiez l'outil web sur votre portail. Selon la quantité de données à consolider et à envoyer sur le serveur, ce processus peut prendre quelques minutes.

Utiliser l'outil web

Vous pouvez rechercher et ouvrir les outils Web dans la section Portal (Portail) de la fenêtre Catalog (Catalogue). En plus d’exécuter l’outil dans ArcGIS Pro, le service de géotraitement Service de géotraitement qui l’optimise peut être utilisé dans un script Python ou une application web.

Pour en savoir plus sur la recherche et l'utilisation d'outils web dans ArcGIS Pro