Mit dem Schritt "Web-Anforderung senden" können Sie Anforderungen an REST-Endpunkte senden, um Daten abzurufen oder Updates zu veröffentlichen. Wenn Workflow Manager mit der Rolle ArcGIS Workflow Manager Server Advanced lizenziert ist, können Sie die Antwort des REST-Endpunktes als benutzerdefinierte Ausgabewerte konfigurieren, als Datei speichern und an den Auftrag anhängen. Die benutzerdefinierten Ausgabewerte können zum Abrufen von Token für nachfolgende REST-Aufrufe, zum Festlegen des Pfades, dem der Workflow folgt, oder als Eingaben für weitere Schritte während des gesamten Workflows verwendet werden.
Wenn der Schritt ausgeführt wird, wird die Web-Anforderung an den in dem Schritt definierten REST-Endpunkt gesendet.
Der Schritt kann fertig gestellt werden, indem Sie auf die Schaltfläche Schritt abschließen klicken.
Konfigurieren des Schrittes
Um den Schritt zu konfigurieren, gehen Sie wie folgt vor:
Vorsicht:
Um Sicherheitslücken zu reduzieren, konfigurieren Sie den Schritt "Web-Anforderung senden" nur für vertrauenswürdige Webseiten und Web-Apps.
- Erstellen oder bearbeiten Sie ein Workflow-Diagramm, um das Fenster Schrittbibliothek aufzurufen.
- Ziehen Sie Web-Anforderung senden aus dem Fenster Schrittbibliothek auf den Verbindungspfeil eines Schrittes auf der Workflow-Zeichenfläche.
Das Fenster Schrittdetails wird angezeigt.
- Geben Sie in das Textfeld Schrittname einen Namen für den Schritt ein.
- Klicken Sie im Abschnitt Argumente auf Bearbeiten.
- Klicken Sie auf den Dropdown-Pfeil URL, und wählen Sie aus, welchen Anforderungstyp Sie senden möchten.
- Geben Sie in das Textfeld URL die URL des REST-Endpunktes ein.
- Optional fügen Sie der URL mithilfe der folgenden Syntax Pfadvariablen hinzu:
https://gisserver.domain.com/webadaptorname/apps/workflowmanager/:pathVariable/
Pfadvariablen werden im Abschnitt Pfadvariablen angezeigt.
- Wenn Sie der URL Pfadvariablen hinzugefügt haben, geben Sie im Abschnitt Pfadvariablen einen Wert für jede Variable ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
Tipp:
Klicken Sie auf die Schaltfläche Diese Eingabe unterstützt Arcade-Ausdrücke , und wählen Sie einen ArcGIS Arcade-Ausdruck für das zugehörige Textfeld aus.
- Fügen Sie der Webanforderung optional Abfrageparameter hinzu.
- Klicken Sie auf Schlüssel und Wert hinzufügen im Abschnitt Abfrageparameter.
- Geben Sie in das Textfeld Schlüssel einen Schlüssel ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
- Geben Sie in das Textfeld Wert einen Wert ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
- Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
- Wiederholen Sie die Teilschritte a bis d, um weitere Schlüssel/Wert-Paare hinzuzufügen.
- Klicken Sie auf die Registerkarte Autorisierung.
- Wählen Sie die Authentifizierungsmethode des REST-Endpunktes aus und geben Sie nach Bedarf Authentifizierunginformationen ein.
Vorsicht:
Die Authentifizierungsinformationen, die Sie in dem Schritt eingeben, werden nicht verschlüsselt. Um die Informationen abzusichern, fügen Sie eine verschlüsselte benutzerdefinierte Einstellung hinzu, um die Informationen zu speichern und in dem Schritt mithilfe dynamischer Auftragseigenschaften zu referenzieren.
- Wenn Sie die Option API-Schlüssel oder Token auswählen, können Sie optional auf Alternativ Token über Endpunkt generieren klicken.
Das Dialogfeld Token über Endpunkt generieren wird angezeigt.
- Konfigurieren Sie Token-Einstellungen, um ein Token für die Web-Anforderung zu generieren.
- Wenn Sie die Option API-Schlüssel oder Token auswählen, können Sie optional auf Alternativ Token über Endpunkt generieren klicken.
- Optional klicken Sie auf die Registerkarte Header, um der Anforderung benutzerdefinierte Header-Schlüssel/Wert-Paare hinzuzufügen.
- Klicken Sie im Abschnitt Benutzerdefinierte Header auf Schlüssel und Wert hinzufügen.
- Geben Sie in das Textfeld Schlüssel einen Schlüssel ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
- Geben Sie in das Textfeld Wert einen Wert ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
- Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
- Wiederholen Sie die Teilschritte a bis d, um weitere Schlüssel/Wert-Paare hinzuzufügen.
- Sie können auch auf die Registerkarte Text klicken, um der Web-Anforderung Daten hinzuzufügen.
Der Anforderungstext unterstützt Formulardaten-Schlüssel/Wert-Paare, URL-codierte Schlüssel/Wert-Paare und Rohdaten im JSON- oder im einfachen Textdateiformat.
Tipp:
Sie können auch einen ArcGIS Arcade-Ausdruck verwenden, um benutzerdefinierte Einstellungen abzurufen oder im Textkörper dynamische Werte bereitzustellen.
- Wenn Sie eine Lizenz für ArcGIS Workflow Manager Server Advanced haben, können Sie auch die Ausgabeeinstellungen des Schrittes konfigurieren.
- Optional können Sie auf die Registerkarte Test und auf Testantwort klicken, um die konfigurierte Anforderung zu senden und ihre Antwort anzuzeigen.
Wenn die Web-Anforderung auftragsspezifische Arcade-Ausdrücke enthält, müssen Sie Auftrags-ID einbeziehen aktivieren und eine Auftrags-ID im Textfeld Auftrags-ID angeben, um die Anforderung ordnungsgemäß zu formatieren.
- Klicken Sie auf Speichern, um das Dialogfeld Web-Anforderung konfigurieren zu schließen.
- Klicken Sie auf die Registerkarte Options.
- Konfigurieren Sie Schrittoptionen nach Bedarf.
- Manuell: Der Schritt wird manuell ausgeführt.
- Optional: Der Schritt kann fertiggestellt werden, ohne dass er ausgeführt wird.
- Automatisch: Der Schritt wird ausgeführt, sobald er aktiviert wird.
Hinweis:
Wenn das Workflow-Diagramm so konfiguriert ist, dass automatisch eine Folge von Schritten ausgeführt wird, in der der Schritt "Datenqualität bewerten" oder der Schritt "GP-Service ausführen" enthalten ist, werden Schritte, die nach Ablauf des Benutzer-Tokens, mit dem diese Schrittfolge gestartet wurde, nicht automatisch ausgeführt. Wenn die zusätzlichen automatisierten Schritte ohne manuellen Eingriff ausgeführt werden sollen, müssen Sie über ein Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced verfügen.
- Nach einem Zeitplan ausführen: Der Schritt wird nach einem von Ihnen festgelegten Zeitplan ausgeführt.
- Manuell: Der Schritt wird manuell ausgeführt.
- Im Textfeld Hilfe zum Schritt können Sie einen Hilfetext zum Schritt bereitstellen.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um für die Hilfe zum Schritt einen dynamischen Wert bereitzustellen. Wenn die Hilfe zum Schritt einfachen Text und Arcade-Ausdrücke enthält, muss der Text wie folgt formatiert werden:
'For further assistance, please contact ' + JobCreator($Job) + '.'
- Klicken Sie ggf. auf die Registerkarte Style, um Form und Farbe für den Schritt zu ändern.
- Klicken Sie ggf. auf die Registerkarte Info, und geben Sie im Textfeld Schrittbeschreibung eine Beschreibung für den Schritt ein.
Hinweis:
Die Registerkarte Info enthält auch die ID des Schrittes, die zusammen mit dynamischen Auftragseigenschaften verwendet werden kann, um das Ergebnis eines Schrittes abzurufen.
Konfigurieren von Token-Einstellungen
Wenn der REST-Endpunkt ein Token für die Authentifizierung erfordert, führen Sie die folgenden Schritte aus, um den Schritt "Web-Anforderung senden" für die Generierung eines Token zur Authentifizierung der Web-Anforderung zu konfigurieren.
- Klicken Sie auf den Dropdown-Pfeil URL, und wählen Sie aus, welchen Anforderungstyp Sie senden möchten.
- Geben Sie in das Textfeld URL die URL des REST-Endpunktes ein.
- Fügen Sie der Webanforderung optional Abfrageparameter hinzu.
- Klicken Sie auf Schlüssel und Wert hinzufügen im Abschnitt Abfrageparameter.
- Geben Sie in das Textfeld Schlüssel einen Schlüssel ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
- Geben Sie in das Textfeld Wert einen Wert ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
- Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
- Wiederholen Sie die Teilschritte a bis d, um weitere Schlüssel/Wert-Paare hinzuzufügen.
- Optional klicken Sie auf die Registerkarte Header, um der Anforderung benutzerdefinierte Header-Schlüssel/Wert-Paare hinzuzufügen.
- Klicken Sie im Abschnitt Benutzerdefinierte Header auf Schlüssel und Wert hinzufügen.
- Geben Sie in das Textfeld Schlüssel einen Schlüssel ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
- Geben Sie in das Textfeld Wert einen Wert ein.
Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
- Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
- Wiederholen Sie die Teilschritte a bis d, um weitere Schlüssel/Wert-Paare hinzuzufügen.
- Sie können auch auf die Registerkarte Text klicken, um der Web-Anforderung Daten hinzuzufügen.
Der Anforderungstext unterstützt Formulardaten-Schlüssel/Wert-Paare, URL-codierte Schlüssel/Wert-Paare und Rohdaten im JSON- oder im einfachen Textdateiformat.
Tipp:
Sie können auch einen ArcGIS Arcade-Ausdruck verwenden, um benutzerdefinierte Einstellungen abzurufen oder im Textkörper dynamische Werte bereitzustellen.
- Klicken Sie auf die Registerkarte Token.
- Klicken Sie auf die Umschaltfläche Testmodus im Abschnitt Token.
- Fügen Sie ein Beispiel der Antwort des REST-Endpunktes in das Textfeld Beispielantwort ein.
Beispielantwort im JSON-Format:
{"access_token": "12345abcde", "expires_in":7199, "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "locations": [ { "name": "380 New York Street", "extent": { "xmin": -117.196701, "ymin": 34.055489 } } ]}
- Geben Sie in das Textfeld Ausgabewert einen Namen für das Token ein.
Hierbei handelt es sich um den Namen, mit dem der Schritt das generierte Token referenziert.
- Geben Sie einen JSONPath-Ausdruck in Punkt- oder Klammernotation an, analysieren Sie die Antwort, und geben Sie das generierte Token zurück.
Beispiel-JSONPath in Punktnotation:
$.access_token
Beispiel-JSONPath in Klammernotation:
$['access_token']
Der Wert wird in der Spalte Beispielergebnis angezeigt.
- Klicken Sie auf Zurück zur Schrittkonfiguration, um mit der Schrittkonfiguration fortzufahren.
Konfigurieren von Ausgabeeinstellungen
Lizenz:
Für diese Funktionalität ist eine Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced erforderlich.
Mit der Rolle ArcGIS Workflow Manager Server Advanced können Sie die Antwort des REST-Endpunktes als Datei speichern, an den Auftrag anhängen und als benutzerdefinierte Ausgabewerte konfigurieren. Die Ausgabewerte können zum Festlegen des Pfades, dem der Workflow folgt, oder als Eingaben für weitere Schritte während des gesamten Workflows verwendet werden. Wenn für den Schritt kein Ausgabewert konfiguriert wird, wird der HTTP-Statuscode als Ausgabewert des Schrittes gespeichert. Um die Ausgabeeinstellungen des Schrittes zu konfigurieren, führen Sie die folgenden Schritte aus:
- Klicken Sie im Dialogfeld Web-Anforderung konfigurieren auf die Registerkarte Ausgabe.
Wenn das Dialogfeld Web-Anforderung konfigurieren nicht verfügbar ist, klicken Sie auf den Schritt Web-Anforderung senden auf der Workflow-Zeichenfläche und dann im Abschnitt Argumente im Fenster Schrittdetails auf Bearbeiten.
- Sie können auch im Abschnitt Antwort anhängen auf die Umschaltfläche Aktiviert klicken, um die Antwort des REST-Endpunktes als Datei zu speichern und an den Auftrag anzuhängen.
- Führen Sie optional diese Schritte aus, um den Anlagennamen und den Ordner zu konfigurieren, in dem sie gespeichert werden soll:
- Geben Sie in das Textfeld Ordnername den Namen des Ordners ein, in dem die Anlage gespeichert werden soll.
Der Ordnername darf keinen Dateisystempfad und keine Sonderzeichen enthalten. Wenn kein Ordnername angegeben wird, wird automatisch ein Ordner mit dem Namen "Allgemein" erstellt.
Hinweis:
Der Ordner ist im Workflow-Element enthalten und ist kein Dateisystempfad.
- Wählen Sie als Anlagennamen eine der folgenden Optionen aus:
- Automatisch generiert: Hierüber wird die Anlage automatisch unter Verwendung der folgenden Syntax benannt: <StepName>_<RunDate>_<RunTime>.
- Benutzerdefiniert: Hierüber kann ein benutzerdefinierter Anlagenname eingegeben werden.
- Geben Sie in das Textfeld Ordnername den Namen des Ordners ein, in dem die Anlage gespeichert werden soll.
- Führen Sie optional die folgenden Schritte aus, um benutzerdefinierte Ausgabewerte für die Antwort des REST-Endpunktes zu konfigurieren:
- Klicken Sie auf die Umschaltfläche Testmodus im Abschnitt Ausgabewerte.
- Fügen Sie ein Beispiel der Antwort des REST-Endpunktes in das Textfeld Beispielantwort ein.
Beispielantwort im JSON-Format:
{"access_token": "", "expires_in":7199, "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "locations": [ { "name": "380 New York Street", "extent": { "xmin": -117.196701, "ymin": 34.055489 } } ]}
- Klicken Sie auf Ausgabe und Pfad hinzufügen.
- Geben Sie in das Textfeld Ausgabewert einen Namen für den Ausgabewert ein.
Dies ist der Wertname, der verwendet wird, um den benutzerdefinierten Ausgabewert zu erhalten.
- Geben Sie in das Textfeld Extraktionspfad in Punktnotation oder Klammernotation einen JSONPath-Ausdruck für den Wert ein, den Sie speichern möchten.
Beispiel-JSONPath in Punktnotation:
$.locations.0.name
Beispiel-JSONPath in Klammernotation:
$['locations'][0]['name']
Der Wert wird in der Spalte Beispielergebnis angezeigt.
- Optional wiederholen Sie die Teilschritte c bis e, um weitere benutzerdefinierte Ausgabewerte hinzuzufügen.
- Klicken Sie auf Speichern, um das Dialogfeld Web-Anforderung konfigurieren zu schließen.
Rückgabewert
Nach Abschluss des Schrittes wird der Rückgabewert gespeichert, um das Ergebnis des Schrittes anzuzeigen. Der Rückgabewert kann mithilfe von Pfaden sofort ausgewertet werden, um die nächsten Schritte im Workflow zu bestimmen. Mithilfe von ArcGIS Arcade-Ausdrücken können Sie während des gesamten Workflows auch den Rückgabewert eines abgeschlossenen Schrittes abrufen. In der folgenden Tabelle sind die Rückgabewerte des Schrittes aufgeführt:
Rückgabewerte | Beschreibung |
---|---|
S000001 | Der Schritt wurde erfolgreich abgeschlossen. |
F000001 | Der Schritt wurde nicht erfolgreich abgeschlossen. |
Ausgabewert
Lizenz:
Für diese Funktionalität ist eine Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced erforderlich.
Nach Abschluss des Schrittes wird der Ausgabewert gespeichert. Er kann dann zum Festlegen des Pfades, dem der Workflow folgt, oder als Eingaben für weitere Schritte während des gesamten Workflows verwendet werden. In der folgenden Tabelle wird der Ausgabewert des Schrittes angezeigt:
Ausgabe | Beschreibung |
---|---|
Status | Gibt den HTTP-Antwortcode zurück, wenn für den Schritt kein Ausgabewert konfiguriert ist. |
<CustomOutputValue> | Gibt den benutzerdefinierten Ausgabewert zurück, den Sie für den Schritt konfiguriert haben. |