Hinzufügen und Konfigurieren des Schrittes "Web-Anforderung senden"—ArcGIS Workflow Manager

Lizenz:

Für diese Funktion ist eine Lizenz für die Organisationserweiterung ArcGIS Workflow Manager Advanced erforderlich.

Mit dem Schritt "Web-Anforderung senden" können Sie Anforderungen an REST-Endpunkte senden, um Daten abzurufen oder Updates zu veröffentlichen. Sie können 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 Workflow-Pfades oder als Eingabewerte für weitere Schritte verwendet werden.

Wenn der Schritt ausgeführt wird, wird die Web-Anforderung an den in dem Schritt definierten REST-Endpunkt gesendet.

Sie können den Schritt fertigstellen, indem Sie auf Schritt abschließen Complete Step 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.
Weitere Informationen zum Hinzufügen von Schritten zu einem Workflow-Diagramm

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://yourorg.maps.arcgis.com/apps/workflowmanager/:pathVariable/
```
Pfadvariablen werden im Abschnitt Pfadvariablen angezeigt.
Sie können der Web-Anforderung auch Abfrageparameter hinzufügen.
1. Klicken Sie auf Schlüssel und Wert hinzufügen im Abschnitt Abfrageparameter.
2. 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.
3. Geben Sie in das Textfeld Wert einen Wert ein.
  Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
4. Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
5. Wiederholen Sie die Teilschritte a bis d, um weitere Schlüssel/Wert-Paare hinzuzufügen.
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 Diese Eingabe unterstützt Arcade-Ausdrücke , und wählen Sie einen Arcade-Ausdruck für das zugehörige Textfeld aus.
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. Sie können Informationen sicher speichern, indem Sie eine verschlüsselte benutzerdefinierte Einstellung hinzufügen, die im Schritt mithilfe dynamischer Auftragseigenschaften referenziert werden kann.
Hinweis:
Mithilfe der Option Verbundenes Token können Sie Web-Anforderungen als der Benutzer authentifizieren, der diesen Schritt durchführt. Die Option Verbundenes Token ist nur mit Services kompatibel, auf die der Workflow Manager-Benutzer zugreifen kann.
1. 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.
2. Konfigurieren Sie Token-Einstellungen, um ein Token für die Web-Anforderung zu generieren.
Optional klicken Sie auf die Registerkarte Header, um der Web-Anforderung benutzerdefinierte Header-Schlüssel/Wert-Paare hinzuzufügen.
1. Klicken Sie im Abschnitt Benutzerdefinierte Header auf Schlüssel und Wert hinzufügen.
2. 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.
3. Geben Sie in das Textfeld Wert einen Wert ein.
  Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
4. Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
5. 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 über eine Lizenz für die Organisationserweiterung ArcGIS Workflow Manager Advanced verfügen, 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 "GP-Service ausführen" enthalten ist, werden Schritte nach Ablauf des Benutzer-Token nicht automatisch ausgeführt. Wenn zusätzliche automatisierte Schritte ohne manuellen Eingriff ausgeführt werden sollen, müssen Sie über die Organisationserweiterung "ArcGIS Workflow Manager Advanced" verfügen.
- Nach einem Zeitplan ausführen: Der Schritt wird nach einem festgelegten Zeitplan ausgeführt.
  Weitere Informationen zu Planungsoptionen
Wählen Sie optional eine der folgenden Optionen, um die Hilfe in diesem Schritt zu konfigurieren:
- Keine: Hierüber konfigurieren Sie den Schritt ohne Schritthilfe.
- Text: Hierüber konfigurieren Sie den Hilfetext für den Schritt im Textfeld Text.
  Sie können ArcGIS Arcade-Ausdrücke verwenden, um für die Hilfe zum Schritt einen dynamischen Wert bereitzustellen. Wenn die Schritthilfe Text und Arcade-Ausdrücke enthält, muss der Text wie folgt formatiert werden:
```
'For further assistance, please contact' + JobCreator($Job) + '.'
```
- URL: Hierüber konfigurieren Sie den Schritt mit einem Link zu einer Hilfe im Textfeld URL.
  Hinweis:
  Bei in der Web-App ausgeführten Schritten werden nur die URL-Formate HTTP und HTTPS unterstützt. Bei in ArcGIS Pro ausgeführten Schritten werden HTTP, HTTPS und Dateiformate unterstützt.
  
  Sie können auch Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen. Wenn die URL Text und Arcade-Ausdrücke enthält, muss der Text wie folgt formatiert werden:
```
'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'
```
  Konfigurieren Sie das Kontrollkästchen Arcade-Ergebnis automatisch codieren wie folgt:
  - Wenn ein Arcade-Ausdruck ein Ergebnis zurückgibt, in dem Sonderzeichen enthalten sind, die beim Konvertieren in eine URL mit Escape-Zeichen versehen werden müssen, wie zum Beispiel ein Leerzeichen oder ein Schrägstrich, dann stellen Sie sicher, dass das Kontrollkästchen Arcade-Ergebnis automatisch codieren aktiviert ist.
  - Wenn ein Arcade-Ausdruck zum Erstellen der Basis-URL verwendet wird, dann deaktivieren Sie das Kontrollkästchen Arcade-Ergebnis automatisch codieren.
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.
Tipp:
Die Registerkarte Info enthält auch die ID des Schrittes, die zusammen mit dynamischen Auftragseigenschaften verwendet werden kann, um das Ergebnis eines Schrittes abzurufen. Klicken Sie auf Schritt-ID kopieren , um die Schritt-ID in die Zwischenablage zu kopieren.

Konfigurieren von Token-Einstellungen

Wenn beim REST-Endpunkt, an den Sie eine Web-Anforderung senden, für die Authentifizierung ein Token erforderlich ist, führen Sie die folgenden Schritte aus, um den Schritt "Web-Anforderung senden" so zu konfigurieren, dass für eine Authentifizierung ein Token generiert wird:

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://yourorg.maps.arcgis.com/apps/workflowmanager/:pathVariable/
```
Pfadvariablen werden im Abschnitt Pfadvariablen angezeigt.
Sie können der Web-Anforderung auch Abfrageparameter hinzufügen.
1. Klicken Sie auf Schlüssel und Wert hinzufügen im Abschnitt Abfrageparameter.
2. 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.
3. Geben Sie in das Textfeld Wert einen Wert ein.
  Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
4. Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
5. Wiederholen Sie die Teilschritte a bis d, um weitere Schlüssel/Wert-Paare hinzuzufügen.
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 Diese Eingabe unterstützt Arcade-Ausdrücke , und wählen Sie einen Arcade-Ausdruck für das zugehörige Textfeld aus.
Optional klicken Sie auf die Registerkarte Header, um der Web-Anforderung benutzerdefinierte Header-Schlüssel/Wert-Paare hinzuzufügen.
1. Klicken Sie im Abschnitt Benutzerdefinierte Header auf Schlüssel und Wert hinzufügen.
2. 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.
3. Geben Sie in das Textfeld Wert einen Wert ein.
  Sie können auch ArcGIS Arcade-Ausdrücke verwenden, um einen dynamischen Wert bereitzustellen.
4. Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
5. 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
},
"location": [
  {
    "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 im Textfeld Extraktionspfad einen JSONPath-Ausdruck in Punkt- oder Klammernotation an, um die Antwort zu analysieren und das generierte Token zurückzugeben.
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 Funktion ist eine Lizenz für die Organisationserweiterung ArcGIS Workflow Manager Advanced erforderlich.

Sie können die Antwort des REST-Endpunktes als Datei speichern, an den Auftrag anhängen und als benutzerdefinierte Ausgabewerte konfigurieren. Die Ausgabewerte können zum Festlegen von Workflow-Pfaden oder als Eingabewerte für weitere Schritte verwendet werden. Wenn für den Schritt kein Ausgabewert konfiguriert wird, wird der HTTP-Statuscode als Ausgabewert des Schrittes gespeichert. Gehen Sie wie folgt vor, um die Ausgabeeinstellungen des Schrittes zu konfigurieren:

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.
Sie können den Anlagennamen und den Ordner konfigurieren, in dem die Antwort gespeichert wird:
1. 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.
2. 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.
Sie können optional benutzerdefinierte Ausgabewerte für die Antwort des REST-Endpunktes konfigurieren:
1. Klicken Sie auf die Umschaltfläche Testmodus im Abschnitt Ausgabewerte.
2. 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 }, "location": [ { "name": "380 New York Street", "extent": { "xmin": -117.196701, "ymin": 34.055489 } } ]}
3. Klicken Sie auf Ausgabe und Pfad hinzufügen.
4. 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.
5. 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:
  $.location.0.name
  Beispiel-JSONPath in Klammernotation:
  $['location'][0]['name']
  Der Wert wird in der Spalte Beispielergebnis angezeigt.
6. 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ückgabewert	Beschreibung
S000001	Der Schritt wurde erfolgreich abgeschlossen.
F000001	Der Schritt wurde nicht erfolgreich abgeschlossen.

Ausgabewert

Lizenz:

Für diese Funktion ist eine Lizenz für die Organisationserweiterung ArcGIS Workflow Manager 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 ist der Ausgabewert des Schrittes aufgeführt:


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.
attachmentId	Gibt ein Array mit Anlagen-IDs zurück, die dem Schritt hinzugefügt wurden.

Lizenz:

Konfigurieren des Schrittes

Vorsicht:

Tipp:

Vorsicht:

Hinweis:

Tipp:

Hinweis:

Hinweis:

Tipp:

Konfigurieren von Token-Einstellungen

Tipp:

Tipp:

Konfigurieren von Ausgabeeinstellungen

Lizenz:

Hinweis:

Rückgabewert

Ausgabewert

Lizenz:

Verwandte Themen

In diesem Thema