Veröffentlichen eines Notebooks als Web-Werkzeug

Ab Version 10.9.1 von ArcGIS Notebooks können Sie Notebooks als Web-Werkzeuge veröffentlichen. Administratoren und Notebook-Autoren mit der Berechtigung "Web-Werkzeuge veröffentlichen" können Notebooks, deren Besitzer sie sind, als Web-Werkzeuge veröffentlichen. Beim Veröffentlichen eines Notebooks als Web-Werkzeug wird auf dem ArcGIS Notebook Server-Computer ein asynchroner Geoverarbeitungsservice erstellt und als Web-Werkzeug registriert. Zwischen dem Notebook und dem Web-Werkzeug besteht eine Eins-zu-Eins-Beziehung. Dies bedeutet, dass pro Notebook nur ein Web-Werkzeug veröffentlicht werden kann. Zudem werden dem Web-Werkzeugelement die gleichen Freigabeberechtigungen wie dem übergeordneten Notebook zugewiesen. Web-Werkzeuge können von jeder Client-Anwendung verwendet werden, die mit asynchronen RESTful-Geoverarbeitungsservices ausgeführt werden kann.

Das Veröffentlichen von Notebooks als Web-Werkzeug wird für Notebooks unterstützt, die Runtime-Version 6.0 oder höher nutzen. Zum Überprüfen der Runtime-Informationen eines Notebooks klicken Sie auf die Schaltfläche Info, die sich im oberen Menüband des Notebook-Editors sowie auf der Registerkarte Einstellungen auf der Elementseite des Notebooks befindet. Weitere Informationen zu Notebook-Runtimes finden Sie unter Anzeigen von verfügbaren Python-Bibliotheken.

In Version 10.9.1 bietet der Notebook-Editor eine neue Funktion, mit der Sie die Eingabe- und Ausgabeparameter für ein Notebook konfigurieren können. Die Eingabeparameter entsprechen den Eingabevariablen in einem Notebook, die Sie für Benutzereingaben externalisieren möchten, wenn das Notebook als Web-Werkzeug ausgeführt wird. Die Ausgabeparameter stellen die Ausgabevariablen in einem Notebook dar, die als Ausgaben des Web-Werkzeugs zurückgegeben werden sollen. Wenn Sie eine oder mehrere Eingabe- oder Ausgabevariablen registrieren und ein Notebook veröffentlichen, werden die Parameter als Eingabe- bzw. Ausgabeparameter für das entsprechende Web-Werkzeug verfügbar.

Hinweis:

Beim Veröffentlichen eines Notebooks als Web-Werkzeug müssen keine Eingabe- oder Ausgabeparameter definiert werden. Beispielsweise erfordern Notebooks, die Tasks mit vordefinierten Eingaben und Ausgaben ausführen, z. B. von itemId referenzierte Feature-Layer, möglicherweise keine Eingabe- oder Ausgabeparameter.

Hinweis:

Für Eingabe- oder Ausgabeparameter werden die folgenden Datentypen unterstützt: "Zeichenfolge", "Long", "Double", "Boolean", "Feature-Set", "Datensatz", "Datum" und "Lineare Einheit". Weitere Informationen finden Sie unter Geoprocessing services data types in der Dokumentation zur ArcGIS Notebook Server-REST-API.

Beim Ausführen eines Web-Werkzeugs führt ArcGIS Notebook Server automatisch das Notebook auf dem Notebook-Server-Computer aus, indem ein neuer Container geöffnet und das Notebook ohne Benutzereingriff ausgeführt wird. Benutzer mit Notebook-Berechtigungen und Benutzer, für die das Notebook freigegeben wurde, können auf das Web-Werkzeug zugreifen und es ausführen. Neben den erforderlichen Notebook-Berechtigungen sind auch alle anderen für die Ausführung des Notebooks notwendigen Berechtigungen erforderlich.

Hinweis:

Wenn Sie ein Notebook erstellen, das als Web-Werkzeug freigegeben werden soll, und dieses eine Datei aus Ihrem Workspace-Verzeichnis als Eingabedaten referenziert, können andere Personen, für die das Notebook oder Web-Werkzeug freigegeben wird, nicht auf die Dateien zugreifen. Wenn Dateien als Eingabedaten im Notebook referenziert werden müssen, können Sie die Dateien über ein freigegebenen Portal-Element in Portal for ArcGIS referenzieren oder aus einem bei ArcGIS Notebook Server registrierten benutzerdefinierten Datenverzeichnis hochladen und referenzieren.

Standardmäßig erfolgen durch ArcGIS Notebook Server maximal 10 gleichzeitige nicht interaktive Notebook-Ausführungen pro ArcGIS Notebook Server-Computer. Hierin sind durch Web-Werkzeuge, geplante Tasks, die executeNotebook-API und Webhook-Trigger ausgelöste Ausführungen eingeschlossen. Dieses Limit kann ggf. von Administratoren erhöht werden.

Hinweis:

Wenn die Option Parameter oder Veröffentlichen nicht im Notebook-Editor angezeigt wird, verfügen Sie nicht über die Berechtigung "Web-Werkzeuge veröffentlichen", oder Sie sind nicht der Besitzer des Notebooks. In einem neu veröffentlichten Notebook werden die Optionen Parameter und Veröffentlichen erst angezeigt, nachdem das Notebook gespeichert wurde.

Konfigurieren von Eingabeparametern

Eingabeparameter stellen Eingabevariablen in einem Notebook dar, die externalisiert werden, wenn ein Notebook als Web-Werkzeug ausgeführt wird. Im Bereich Parameter des Notebook-Editors können Sie Eingabeparameter konfigurieren und dem Notebook als Variablen hinzufügen.

1. Klicken Sie im Notebook-Editor auf Parameter.
2. Klicken Sie auf Hinzufügen.
3. Wählen Sie als Richtung "Eingabe" aus.
4. Geben Sie unter Variablenname einen Namen an.

   Hinweis:

   Dieser muss mit einem Variablennamen im Notebook-Code oder einem bereits im Notebook konfigurierten Variablennamen übereinstimmen.

5. Geben Sie in Anzeigename einen Anzeigenamen für den Web-Werkzeug-Parameter an.
6. Wählen Sie im Dropdown-Menü Datentyp einen Datentyp für den Eingabeparameter aus.
7. Geben Sie für den Eingabeparameter einen Wert für Default value an. Informationen zur Syntax der Standardwerte für unterstützte Datentypen finden Sie unter Geoprocessing services data types.
8. Geben Sie für Description eine Beschreibung des Eingabeparameters an.
9. Klicken Sie auf Speichern, um den Eingabeparameter zu speichern.
10. Um zusätzliche Eingabeparameter hinzuzufügen, wiederholen Sie die Schritte 1 bis 9.
11. Nachdem Sie alle Eingabeparameter hinzugefügt haben, wählen Sie im Notebook eine Zelle aus, in die die Parameter eingefügt werden sollen, und klicken Sie auf Als Variablen einfügen.
12. Klicken Sie auf Speichern, um das Notebook zu speichern.

Konfigurieren von Ausgabeparametern

Sie können die Ausgabe für ein als Web-Werkzeug veröffentlichtes Notebook durch Konfigurieren der Ausgabeparameter im Bereich Parameter des Notebook-Editors konfigurieren.

1. Klicken Sie im Notebook-Editor auf Parameter.
2. Klicken Sie auf Hinzufügen.
3. Wählen Sie für den Parameter Direction "Ausgabe" aus.
4. Geben Sie unter Variable name einen Namen an.

   Hinweis:

   Dieser muss mit einem Variablennamen im Notebook-Code oder einem bereits im Notebook konfigurierten Variablennamen übereinstimmen.

5. Geben Sie unter Display name einen Anzeigenamen für den Web-Werkzeug-Parameter an.
6. Wählen Sie im Dropdown-Menü Data type einen Datentyp für den Ausgabeparameter aus.
7. Geben Sie für den Ausgabeparameter einen Wert für Default value an. Informationen zur Syntax der Standardwerte für unterstützte Datentypen finden Sie unter Geoprocessing services data types.
8. Geben Sie für Descriptioneine Beschreibung des Ausgabeparameters ein.
9. Klicken Sie auf Speichern, um den Ausgabeparameter zu speichern.
10. Wählen Sie eine Zelle im Notebook aus. Klicken Sie auf die Schaltfläche Hinzufügen, um den Python-Codeausschnitt zum Schreiben der Ausgabe für das Web-Werkzeug hinzuzufügen.

    Es wird empfohlen, eine Zelle im unteren Bereich des Notebooks unter den Zellen auszuwählen, in denen die Ausgaben erstellt werden.

11. Überprüfen Sie den hinzugefügten Codeausschnitt, um sicherzustellen, dass die Ausgabevariablennamen mit der im Notebook definierten Ausgabe übereinstimmen, und nehmen Sie weitere Anpassungen des Codeausschnitts vor.
12. Wiederholen Sie für alle zusätzlichen Ausgabeparameter die Schritte 1 bis 11.
13. Klicken Sie auf Speichern, um das Notebook zu speichern.

Veröffentlichen eines Web-Werkzeugs

Sie können über den Bereich Veröffentlichen im Notebook-Editor ein Notebook als Web-Werkzeug veröffentlichen.

1. Speichern Sie das Notebook, um sicherzustellen, dass die aktuelle Kopie des Notebooks veröffentlicht wird.
2. Führen Sie die Zellen des Notebooks manuell interaktiv aus, um sicherzustellen, dass keine Fehler vorhanden sind.

Hinweis:

Überspringen Sie Zellen, die Codeausschnitte für Ausgabeparameter enthalten, da sie im interaktiven Modus nicht ausgeführt werden.
3. Klicken Sie auf dem Menüband des Notebook-Editors auf Veröffentlichen.
4. Geben Sie im Bereich Veröffentlichen in den Feldern Title und Description einen Titel und eine Beschreibung für das Web-Werkzeug an.
5. Überprüfen Sie alle Eingabe- und Ausgabeparameter.
6. Klicken Sie auf Veröffentlichen, um das Notebook als Web-Werkzeug zu veröffentlichen.
7. Nachdem das Web-Werkzeug erfolgreich veröffentlicht wurde, klicken Sie auf Details anzeigen, um die Elementdetailseite für das Web-Werkzeug anzuzeigen.

Löschen eines Web-Werkzeugs

Sie können einen über ein Notebook veröffentlichten Geoverarbeitungsservice löschen, indem Sie das Web-Werkzeugelement löschen.

1. Klicken Sie dazu auf dem Menüband oben im Notebook-Editor auf Veröffentlichen.
2. Klicken Sie auf die Schaltfläche Details anzeigen, um die Elementdetailseite für das Web-Werkzeug anzuzeigen.
3. Klicken Sie auf Einstellungen.
4. Klicken Sie auf Element löschen, und bestätigen Sie, dass Sie das Web-Werkzeugelement und den Geoverarbeitungsservice löschen möchten, die in ArcGIS Notebook Server veröffentlicht wurden.

Bearbeiten eines vorhandenen Eingabe- oder Ausgabeparameters

Sie können im Bereich Parameter des Notebook-Editors Änderungen an einem vorhandenen Eingabe- oder Ausgabeparameter vornehmen.

Hinweis:

Wenn ein Notebook bereits als Web-Werkzeug veröffentlicht wurde, müssen Sie im Bereich Parameter auf die Umschaltfläche Bearbeitung aktivieren klicken, bevor Sie Änderungen an den Parametern vornehmen können. Gehen Sie umsichtig vor, wenn Sie Parameter ändern, nachdem das Notebook als Web-Werkzeug veröffentlicht wurde, da durch diese Änderungen möglicherweise Web-Apps beschädigt werden, die das Web-Werkzeug verwenden.

1. Klicken Sie dazu auf dem Menüband oben im Notebook-Editor auf Parameter.
2. Klicken Sie auf die Schaltfläche "Optionen" neben dem Parameter, und klicken Sie auf Bearbeiten.
3. Aktualisieren Sie die Parameter, und klicken Sie auf Speichern.
   1. Wenn ein Eingabeparameter aktualisiert wurde, löschen oder entfernen Sie die vorhandene Zelle mit den Eingabevariablen manuell. Wiederholen Sie dann den Schritt zum Einfügen der Eingabeparameter als Variablen in das Notebook.
   2. Wenn ein Ausgabeparameter aktualisiert wurde, löschen Sie den der Ausgabevariablen entsprechenden Codeausschnitt manuell. Wiederholen Sie dann die Schritte zum Hinzufügen des Codeausschnitts für den Ausgabeparameter zum Notebook.
4. Klicken Sie auf Speichern, um das Notebook zu speichern.

Löschen eines vorhandenen Eingabe- oder Ausgabeparameters

Sie können im Bereich Parameter vorhandene Eingabe- oder Ausgabeparameter löschen.

1. Klicken Sie dazu auf dem Menüband oben im Notebook-Editor auf Parameter.
2. Klicken Sie auf die Schaltfläche "Optionen" neben dem Parameter, und klicken Sie auf Löschen.
3. Klicken Sie auf Löschen, um den Parameter endgültig zu entfernen.
4. Löschen oder entfernen Sie die Eingabevariable oder den Ausgabecodeausschnitt im Notebook manuell.
5. Klicken Sie auf Speichern, um das Notebook zu speichern.

Verwenden der Kartenausdehnung

Wenn Sie ein Web-Werkzeug in Map Viewer Classic ausführen, wird die Kartenausdehnung als Python-Variable mit dem Namen context zusammen mit anderen Eingabeparametern an das Notebook übergeben (siehe unten).

context = {
    "extent": {
        "ymin": -25203428.462408017,
        "xmin": -46101923.491795965,
        "ymax": 25203428.462407943,
        "xmax": 46101923.491795965,
        "spatialReference": {
            "wkt": "PROJCS[\"WGS_1984_Web_Mercator_Auxiliary_Sphere\",GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Mercator_Auxiliary_Sphere\"],PARAMETER[\"False_Easting\",0.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",0],PARAMETER[\"Standard_Parallel_1\",0.0],PARAMETER[\"Auxiliary_Sphere_Type\",0.0],UNIT[\"Meter\",1.0]]"
        },
    }
}

Mit dem Wert der context-Variablen können Sie die Ausdehnung für die Workflows für räumliche Analysen in Ihrem Notebook festlegen. Um Ihre Workflows für die räumliche Analyse mit einer Kartenausdehnung zu testen, bevor Sie das Notebook als Web-Werkzeug veröffentlichen, definieren Sie die context-Variable mit einem Standardwert.

Wenn Sie bereit für die Veröffentlichung sind, fügen Sie die Eingabeparameter als Variablen nach der Zelle ein, in der Sie die context-Variable angeben.

Problembehandlung bei Web-Werkzeugen

Nach der Veröffentlichung eines Notebooks als Web-Werkzeug können Sie überprüfen, ob das Web-Werkzeug erfolgreich ausgeführt wird, indem Sie den Task über das ArcGIS Notebook Server-Services-Verzeichnis ausführen.

1. Öffnen Sie das ArcGIS Notebook Server-Services-Verzeichnis https://notebookserver.domain.com/webadaptorcontext/rest/services in einem Webbrowser.
2. Melden Sie sich als Besitzer des Web-Werkzeugs an.
3. Identifizieren Sie den Service, und navigieren Sie zur Seite "Tasks".
4. Klicken Sie auf Auftrag senden.
5. Geben Sie Eingabeparameter an, und klicken Sie auf Auftrag senden.
6. Klicken Sie optional auf den Link Auftragsdetails erneut prüfen, um den Status des Auftrags zu überprüfen.

   Wenn das Web-Werkzeug erfolgreich ausgeführt wird, werden Links zu den Ausgaben bereitgestellt. Standardmäßig wird sowohl bei erfolgreicher als auch bei fehlgeschlagener Ausführung des Notebooks eine HTML-Vorschau der Ausführung angezeigt.

7. Laden Sie die HTML-Vorschau des Notebooks herunter, und zeigen Sie sie an, um zu überprüfen, ob bei der Ausführung des Web-Werkzeugs Probleme aufgetreten sind.
8. Wenn die Ausführung des Web-Werkzeugs fehlschlägt, überprüfen Sie im Notebook-Editor, ob das Notebook erfolgreich ausgeführt wird.