Hinzufügen und Konfigurieren des Schrittes "Web-Anforderung senden"

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

To configure the step, do the following:

Vorsicht:

Um Sicherheitslücken zu reduzieren, konfigurieren Sie den Schritt "Web-Anforderung senden" nur für vertrauenswürdige Webseiten und Web-Apps.

1. Create or edit a workflow diagram to access the Step Library panel.
2. Ziehen Sie Web-Anforderung senden aus dem Fenster Schrittbibliothek auf den Verbindungspfeil eines Schrittes auf der Workflow-Zeichenfläche.

   Learn more about adding steps to a workflow diagram

   The Step Details panel appears.

3. Provide a name for the step in the Step Name text box.
4. Klicken Sie im Abschnitt Argumente auf Bearbeiten.
5. Klicken Sie auf den Dropdown-Pfeil URL, und wählen Sie aus, welchen Anforderungstyp Sie senden möchten.
6. Geben Sie in das Textfeld URL die URL des REST-Endpunktes ein.
7. 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.

8. Wenn Sie der URL Pfadvariablen hinzugefügt haben, geben Sie im Abschnitt Pfadvariablen einen Wert für jede Variable ein.
9. 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.
   3. Geben Sie in das Textfeld Wert einen Wert ein.
   4. Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
   5. Wiederholen Sie die Teilschritte a bis d, um weitere Schlüssel/Wert-Paare hinzuzufügen.
10. Klicken Sie auf die Registerkarte Autorisierung.
11. 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.

12. 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.
    3. Geben Sie in das Textfeld Wert einen Wert ein.
    4. Lassen Sie das Kontrollkästchen Aktiviert aktiviert.
    5. Wiederholen Sie die Teilschritte a bis d, um weitere Schlüssel/Wert-Paare hinzuzufügen.
13. 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 Arcade-Ausdruck verwenden, um benutzerdefinierte Einstellungen abzurufen oder im Text dynamische Werte anzugeben.

14. Wenn Sie eine Lizenz für ArcGIS Workflow Manager Server Advanced haben, können Sie auch die Ausgabeeinstellungen des Schrittes konfigurieren.
15. Klicken Sie auf Speichern, um das Dialogfeld Web-Anforderung konfigurieren zu schließen.
16. Click the Options tab.
17. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.

      Hinweis:

      If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

18. Optionally, provide help text for the step in the Step Help text box.

    You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

    'For further assistance, please contact ' + jobCreator($job) + '.'

19. Optionally, click the Style tab to change the shape and color of the step.
20. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    Hinweis:

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

Konfigurieren von Ausgabeeinstellungen

Lizenz:

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

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:

1. 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.

2. 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.
3. Führen Sie optional diese Schritte aus, um den Anlagennamen und den Ordner zu konfigurieren, in dem sie gespeichert werden soll:
   1. Geben Sie in das Textfeld Ordnername den Namen des Ordners ein, in dem die Anlage gespeichert werden soll.

      Der Ordnername darf keine Sonderzeichen enthalten.

      Hinweis:

      Wenn kein Ordnername angegeben wird, wird automatisch ein Ordner mit dem Namen "Allgemein" erstellt.

   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.
4. Führen Sie optional die folgenden Schritte aus, um benutzerdefinierte Ausgabewerte für die Antwort des REST-Endpunktes zu 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
      },
      "locations": [
        {
          "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:

      $.locations.0.name

      Beispiel-JSONPath in Klammernotation:

      $['locations'][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.
5. Klicken Sie auf Speichern, um das Dialogfeld Web-Anforderung konfigurieren zu schließen.

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

Ausgabewert

Lizenz:

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

When the step is completed, its output value is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table shows the step's output value:

Ausgabe	Beschreibung	Syntax für ArcGIS Arcade-Ausdruck
Status	Gibt den HTTP-Antwortcode zurück, wenn für den Schritt kein Ausgabewert konfiguriert ist.	jobOutputValue($job, '<step_id>', 'Status')
<CustomOutputValue>	Gibt den benutzerdefinierten Ausgabewert zurück, den Sie für den Schritt konfiguriert haben.	jobOutputValue($job, '<step_id>', '<custom_output_value_name>')