Die Erstellung eines Web-Werkzeugs beinhaltet sowohl einen Erstellungs- als auch einen Freigabeprozess. Der Erstellungsprozess beginnt mit der Erstellung eines Modell- oder Python-Skriptwerkzeugs in ArcGIS Pro. Nachdem Sie das Werkzeug erstellt und erfolgreich ausgeführt haben, können Sie es im ArcGIS Enterprise-Portal als Web-Werkzeug freigeben. Bei der Erstellung und Freigabe müssen bestimmte Daten, Werkzeugparamater und Freigabeberechtigungen berücksichtigt werden. Einige dieser Überlegungen werden im folgenden Beispiel und in relevanten Abschnitten dieses Themas erläutert. Der folgende Workflow beschreibt den Gesamtprozess:
- Erstellen Sie ein Skript oder Modell mit Werkzeugen aus der Toolbox, um Ihren Workflow zu konstruieren.
- Sammeln Sie die für das Werkzeug erforderlichen Datasets, und stellen Sie sie in einer Geodatabase zur Verfügung, oder fügen Sie sie der Karte in Ihrem Projekt hinzu.
- Führen Sie das Werkzeug aus, um einen erfolgreichen Eintrag im Geoverarbeitungsverlauf zu erstellen.
- Legen Sie bei Bedarf die Symbolisierung von Ausgabe-Datasets in Ihrer Karte fest.
- Geben Sie das Verlaufselement als Web-Werkzeug frei. Wenn Sie das Web-Werkzeug freigeben, können Sie Werkzeugeigenschaften für das Werkzeug und den Service festlegen.
Beispiel: Überprüfen der Auswirkungen auf den geplanten Bau einer Pipeline auf die Bevölkerung
Das folgende Modellwerkzeug ist eine Sammlung von Werkzeugen, mit deren Hilfe überprüft werden kann, wie viele Menschen von einem Pipeline-Leck betroffen sein könnten. Mit dem Workflow werden Schnittpunkte zwischen der Pipeline und dem Fluss gesucht und eine Verfolgung flussabwärts durchgeführt, um zu ermitteln, wie viele Menschen betroffen sein könnten. Dieses Modell wird mit Projektdaten und -parametern eingerichtet und als Web-Werkzeug veröffentlicht, wobei ein Analyst oder die allgemeine Öffentlichkeit die Route der geplanten Pipeline ändern kann, um etwaige Auswirkungen eines Leck auf die Bevölkerung flussabwärts zu ermitteln. Die Ergebnisse der Web-Werkzeuge zeigen den Punkt an, an dem die Pipeline den Fluss kreuzt, und die Zusammenfassung der von den Auswirkungen betroffenen Bevölkerung.
Werkzeugdesign
Alle nützlichen Werkzeuge verfügen über Ein- und Ausgabeparameter. Mit diesen Werkzeugen können bei jeder Ausführung des Werkzeugs verschiedene Werte ausgeführt werden. Im Gegenzug erzeugt das Werkzeug verschiedene Analysen. Neben Eingabe- und Ausgabeparametern verfügen Werkzeuge im Allgemeinen über Projektdaten und Zwischendaten. Dies sind Datasets, über die die Person, die das Werkzeug ausführt, im Allgemeinen keine Kontrolle hat. In einem Modell sind die Eingabeparameter mit einem P markiert. Wird das Modell als Werkzeug ausgeführt, ist jede Eingabe mit einem P im Werkzeugdialogfeld verfügbar, um einen Wert festzulegen, der beim Ausführen des Werkzeugs verwendet werden soll. Über das Pipeline-Modell kann der Benutzer bei der Verfolgung flussabwärts den Pipeline-Pfad und eine Entfernung zum Puffer festlegen. Bei Verwendung dieses Werkzeugs werden der Pipeline-Standort und die Puffergröße geändert, um die letztendliche Anzahl der von der Pipeline betroffenen Personen anzuzeigen. Die Schnittpunkte der Pipeline und die Verfolgungslinie in diesem Beispiel sind Zwischen-Datasets, die während der Ausführung vom Modellwerkzeug erzeugt werden. Diese Zwischen-Datasets werden weder von der Person benötigt, die das Werkzeug ausführt, noch werden sie als Ergebnis zurückgegeben. Wenn dieses Modell freigegeben wird, legt der zugrunde liegende Geoverarbeitungsservice, auf dem das Web-Werkzeug basiert, fest, wo die Zwischendaten gespeichert werden, und bereinigt sie letztlich, falls sie nicht mehr benötigt werden.
Ausgabeparameter spielen eine ebenso wichtige Rolle wie Eingabeparameter für alle erfolgreichen Werkzeuge. Der Ausgabeparameter ermöglicht dem Werkzeug die Rückgabe eines Ergebnisses an die Person, die das Werkzeug ausführt. In ArcGIS Pro spielen Ausgabeparameter eine wichtige Rolle, da diese Datasets der Karte automatisch hinzugefügt werden. Ein Werkzeug ohne Ausgabeparameter erstellt eine Ausgabe, zeigt diese Informationen jedoch nicht notwendigerweise an. Web-Werkzeuge funktionieren mehr oder weniger genauso; ein oder mehrere Ausgabeparameter sind erforderlich, um das Ergebnis an den Endbenutzer zurückzugeben. Im Pipeline-Modell sind zwei Ausgabeparameter vorhanden: die Bevölkerung betroffener Gebiete, die die Pufferstandorte flussabwärts anzeigen und die Summentabelle der Bevölkerung mit der Zusammenfassung der insgesamt betroffenen Bevölkerung. Beachten Sie, dass es sich bei der Bevölkerung der betroffenen Gebiete sowohl um Zwischen- als auch um Ausgabedaten handelt. Dieser Parameter ist ein Zwischenparameter, da er für das Werkzeug Summenstatistik erforderlich ist, jedoch als Modellparameter definiert wurde (P) und dieses Ergebnis an den Client zurücksendet, wenn das Werkzeug erfolgreich beendet wird.
Tipp:
Beim Erstellen von Skriptwerkzeugen werden dieselben Grundsätze der Eingabe- und Ausgabeparameter von Werkzeugen, Projektdaten und Zwischendaten angewendet.
Dokumentieren des Werkzeugs
Es ist wichtig, eine gute Dokumentation das Web-Werkzeug bereitzustellen, wenn das Werkzeug von einem breiten Publikum gefunden, verstanden und genutzt werden soll. Eine gute Dokumentation beginnt mit dem ursprünglichen Werkzeug. Sie können denselben Metadatentyp für Ihr Modell- oder Skriptwerkzeug bereitstellen wie ein Systemwerkzeug.
Ausführen des Werkzeugs
Nachdem das Werkzeug erstellt wurde, muss es erfolgreich ausgeführt werden. Durch die Ausführung des Werkzeugs wird ein Eintrag im Geoverarbeitungsverlauf erstellt. Eine fehlgeschlagene Werkzeugausführung kann nicht freigegeben werden.
Hinweis:
Bei der Ausführung eines Modells in ModelBuilder wird kein Eintrag im Geoverarbeitungsverlauf erstellt. Modellwerkzeuge müssen im Bereich Geoverarbeitung als Werkzeug ausgeführt werden.
Freigeben von Web-Werkzeugen
Um das Web-Werkzeug freizugeben, wählen Sie Analyse > Verlauf aus, um den Bereich Verlauf zu öffnen. Zum Freigeben klicken Sie mit der rechten Maustaste auf das Element, das freigegeben werden soll, und wählen Freigeben als aus. Zum Freigeben als neues Web-Werkzeug wählen Sie Web-Werkzeug freigeben aus, um den Bereich Als Web-Werkzeug freigeben zu öffnen. Zum Überschreiben eines vorhandenen Werkzeugs wählen Sie Web-Werkzeug überschreiben aus, um einen Bereich mit allen vorhandenen Web-Werkzeugen, die in Eigene Inhalte veröffentlicht wurden, zu öffnen.
Vergewissern Sie sich, dass Sie das richtige Werkzeug zum Überschreiben ausgewählt haben, und wählen Sie OK aus, um den Bereich Web-Werkzeug überschreiben zu öffnen. Die Prozesse vorab veröffentlichter Konfigurationen für Web-Werkzeuge sind für Web-Werkzeug freigeben und Web-Werkzeug überschreiben identisch, wie unten dargestellt.
Sie können auch zu Freigeben > Web-Werkzeug navigieren, um entweder Web-Werkzeug freigeben oder Web-Werkzeug überschreiben auszuwählen. Wenn Sie die Option Web-Werkzeug freigeben auswählen, dann wählen Sie in einem Werkzeugfreigabebereich mit allen erfolgreich ausgeführten Elementen ein Element aus.
Wenn Sie die Option Web-Werkzeug überschreiben auswählen, dann wählen Sie im Bereich mit allen vorhandenen Web-Werkzeugen, die Sie in Eigene Inhalte veröffentlicht haben, ein Element aus, das überschrieben werden soll. Wählen Sie dann im Bereich mit allen erfolgreich ausgeführten Elementen ein Element aus, mit dem überschrieben werden soll. Beim Auswählen in Analyse > Verlauf müssen die Schritte zum Überschreiben in diesem Workflow in umgekehrter Reihenfolge ausgeführt werden.
Festlegen der Eigenschaften von Web-Werkzeugen
Die Ausgabe des Werkzeugs zur Verschmutzungsbewertung sind Features und eine Tabelle. Die von diesem Werkzeug erzeugte und zurückgegebene Datenmenge ist eingeschränkt, sodass das Web-Werkzeug als asynchroner Service ohne Ergebniskartenservice eingerichtet wird. Die Anzahl von maximal 1000 Datensätzen als Standardeinstellung ist ausreichend. Mit der Meldungsebene Fehler wird sichergestellt, dass nur solche Meldungen zurückgegeben werden, die sich auf einen möglichen Fehler des Werkzeugs beziehen. Bei erfolgreicher Ausführung des Web-Werkzeugs werden keine normalen Verarbeitungsmeldungen an den Endbenutzer zurückgegeben.
Ein Web-Werkzeug ist immer unter Eigene Inhalte verfügbar. Sie können das Werkzeug für Ihre Organisation, für alle Benutzer oder für ausgewählte Gruppen freigeben. Das Werkzeug zur Verschmutzungsbewertung ist ein Werkzeug, das für die Freigabe für bestimmte Projektbeteiligte in der Organisation geeignet ist, die Pipeline-Analysen durchführen müssen. Durch Auswahl der entsprechenden Gruppen können diese Benutzer das Werkzeug schnell finden und verwenden.
Kopieren, Referenzieren oder Verwenden von URL-Daten
Die meisten Web-Werkzeuge haben Eingabe- oder Projektdaten. Bei der Freigabe des Verschmutzungsbewertungsmodells als Web-Werkzeug müssen Sie überprüfen, ob es unter den Eingabe- oder Projektdaten Nicht-URL-Daten oder URL-Daten gibt. Sie können Nicht-URL-Daten auf den Server kopieren, indem Sie eine statische Kopie der Daten erstellen, die der Service verwendet. Alternativ können Sie das Kopieren der Daten überspringen und eine Referenz erstellen, auf die der Service zugreifen kann. URL-Daten dienen zur Eingabe einer Service-URL.
Bei der Freigabe des Verschmutzungsbewertungsmodells als Web-Werkzeug enthalten die Projektdaten statische Fluss- und Bevölkerungs-Datasets, d. h. diese Datasets werden selten aktualisiert. Das Kopieren dieser Projektdaten auf den Server ist eine mögliche Lösung. Bei dem Veröffentlichungsprozess werden Daten erfasst und (bei Bedarf) in File-Geodatabase-Feature-Classes konvertiert, wobei sie auf dem Server extrahiert und vom Service verwendet werden. Aktivieren Sie in diesem Fall das Kontrollkästchen Alle Daten kopieren unter der Überschrift Nicht-URL-Daten.
Berücksichtigen Sie, ob die Analysemethode leicht abgeändert wurde und der Benutzer keine eigene Pipeline vorgeschlagen hat. Die alternativen Pipeline-Vorschläge wurden durch einen anderen Prozess erzeugt und der Benutzer hat verschiedene Eingaben für das Werkzeug bereitgestellt. In diesem Fall wird die vorgeschlagene Pipeline zu Projektdaten. Demzufolge ist es empfehlenswert, dieses Dataset in einer Enterprise-Geodatabase oder einem Ordner mit einem UNC-Pfad (Universal Naming Convention) und Serverzugriff abzulegen. Diese Speicherorte ermöglichen, dass das Werkzeug das Dataset referenzieren kann. Aktivieren Sie bei der Freigabe optional das Kontrollkästchen Registrierte Daten referenzieren unter der Überschrift Nicht-URL-Daten, und legen Sie eine Referenz für die Daten fest, die den ArcGIS Server-Data Store verwenden. Der Veröffentlichungsprozess behält eine Referenz auf die Datenbank oder den Ordner bei, statt eine statische Kopie zu erstellen. Die Daten können zu einem späteren Zeitpunkt von einem Projektanalyst in der Enterprise-Geodatabase oder dem Ordner aktualisiert werden und das Web-Werkzeug kann Analysen für den neuesten Pipeline-Vorschlag durchführen.
Eine weitere Möglichkeit ist die Bereitstellung eines Feature-Datasets, das nicht aus einer Pipeline des Benutzers stammt und nicht häufig aktualisiert wird, um die Eingabe aus einem Web-Feature-Layer (Feature-Service) oder einem Kartenbild-Layer (Kartenservice) mit einem Feature-Sublayer bereitzustellen. Deaktivieren Sie während der Veröffentlichung das Kontrollkästchen Feature-Layer konvertieren, um die URL-Daten während des Prozesses beizubehalten. Ist das Kontrollkästchen aktiviert, werden die Daten während der Veröffentlichung auf den Server kopiert und die im Werkzeug verwendeten referenzierten Daten werden zu statischen Daten auf dem Server. Wenn Ihre Eingabe aus einem Raster-Dataset stammt, geben Sie die URL-Daten mit dem Web-Bilddaten-Layer (Image-Service) an. In diesem Fall ist es nicht erforderlich, das Kontrollkästchen Feature-Layer konvertieren zu aktivieren, da die URL während der Veröffentlichung stets beibehalten wird.
Eingabemodus
Bei der Freigabe als Web-Werkzeug ist es wichtig zu entscheiden, wie der Client die Eingabe für Ihren Web-Werkzeug-Task bereitstellt. Dies wird als der Eingabemodus eines Parameters bezeichnet. Für das Konfigurieren der Werkzeugeigenschaften klicken Sie auf der Registerkarte Inhalt neben dem Werkzeugnamen auf die Schaltfläche Werkzeugeigenschaften konfigurieren .
Erweitern Sie im Bereich "Eigenschaften" jeden Parameter und konfigurieren Sie den Eingabemodus für alle Parameter. Bei Auswahl des Eingabemodus Benutzerdefinierter Wert sind keine Überlegungen zu Daten anzustellen, weil die Daten clientseitig während der Ausführung des Web-Werkzeugs bereitgestellt werden. Bei der Auswahl der Option Auswahlliste oder Konstante werden die Daten aus den kopierten oder referenzierten Daten auf dem Server oder aus den Daten aus der Service-URL bereitgestellt.
Wenn das Web-Werkzeug veröffentlicht wird, wird der Standardwert jedes Eingabe- und Ausgabeparameters auf dem REST-Endpunkt des Servers angezeigt. Wenn der Standardwert für einen Parameter nicht angezeigt werden soll, aktivieren Sie das Kontrollkästchen Standardwert entfernen für den entsprecheden Parameter. Wenn der Standardwert für alle Parameter entfernt werden soll, aktivieren Sie unter der Überschrift Parameterkonfiguration das Kontrollkästchen Alle Standardwerte entfernen.
Analysieren
Durch das Analysieren eines potenziellen Web-Werkzeugs wird sichergestellt, dass das Werkzeug erfolgreich für Ihr Portal freigegeben werden kann. Zudem können Warnmeldungen zu Daten angezeigt werden, und Sie können entsprechende Maßnahmen ergreifen, wenn Sie dies für erforderlich halten. Das Werkzeug zur Verschmutzungsbewertung verfügt bereits über einen eingerichteten Data Store und ein dokumentiertes Werkzeug und verwendet unterstützte Werkzeuge, die in einem Web-Werkzeug funktionieren, damit solche Warnungen oder Meldungen nicht angezeigt werden.
Veröffentlichen
Nachdem die Eigenschaften des Web-Werkzeugs festgelegt wurden und Sie alle Analysefehler behoben haben, veröffentlichen Sie das Web-Werkzeug in Ihrem Portal. Je nachdem, wie viele Daten konsolidiert und an den Server gesendet werden müssen, kann dieser Vorgang ein paar Minuten in Anspruch nehmen.
Verwenden des Web-Werkzeugs
Web-Werkzeuge können im Abschnitt Portal des Bereichs Katalog geöffnet werden. Neben der Ausführung des Werkzeugs in ArcGIS Pro kann der Geoverarbeitungsservice , auf dem es basiert, in einem Python-Skript oder einer Webanwendung verwendet werden.
Weitere Informationen zum Suchen und Verwenden von Web-Werkzeugen in ArcGIS Pro