Erstellen und Verwalten von Web-Anforderungs-Vorlagen

Lizenz:

Für diese Funktionalität ist eine Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced erforderlich.

Web-Anforderungs-Vorlagen können mit Auftragsaktivitäten konfiguriert werden, damit beim Ausführen bestimmter Auftragsaktivitäten in einem Workflow automatisch Web-Anforderungen an REST-Endpunkte gesendet werden. Eine Web-Anforderungs-Vorlage kann beispielsweise so konfiguriert werden, dass sie Daten abruft oder Aktualisierungen an ein Drittsystem sendet, wenn ein Auftrag aktualisiert wird. Die Antwort kann in Form von benutzerdefinierten Ausgabewerten gesteuert werden, um Workflow-Pfade zu festzulegen oder Auftragseigenschaften zu aktualisieren.

Erstellen von Web-Anforderungs-Vorlagen

Gehen Sie wie folgt vor, um eine Web-Anforderungs-Vorlage zu erstellen:

1. Rufen Sie die Workflow Manager-Web-App auf.
2. Klicken Sie auf die Registerkarte Entwerfen.

   Die Seite Entwerfen wird angezeigt.

   Hinweis:

   Die Registerkarte Entwerfen ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

3. Klicken Sie auf Vorlagen .

   Hinweis:

   Vorlagen ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

4. Klicken Sie auf die Registerkarte Web-Anforderung.

   Daraufhin wird das Fenster Web-Anforderung angezeigt.

   Hinweis:

   Die Registerkarte Web-Anforderung ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

5. Klicken Sie im Fenster Web-Anforderung auf Neue erstellen.
6. Geben Sie in das Textfeld Name einen Namen für die Web-Anforderung ein.
7. Klicken Sie auf den Dropdown-Pfeil URL, und wählen Sie aus, welchen Anforderungstyp Sie senden möchten.
8. Geben Sie in das Textfeld URL die URL des REST-Endpunktes ein.
9. 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.

10. Sie können der Web-Anforderungs-Vorlage 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.
11. 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 ArcGIS Arcade-Ausdruck für das zugehörige Textfeld aus.

12. Klicken Sie auf die Registerkarte Autorisierung.
13. 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, die auf derselben Enterprise-Site wie Workflow Manager veröffentlicht sind.

    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.
14. Klicken Sie optional auf die Registerkarte Header, um der Web-Anforderungs-Vorlage 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.
15. 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.

16. Wenn Sie eine Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced haben, können Sie die Ausgabeeinstellungen der Web-Anforderungs-Vorlage konfigurieren.

    Hinweis:

    Die Auftragsaktivität, für die die Vorlage konfiguriert wird, muss zuerst durchgeführt werden, erst dann kann der Ausgabewert der Web-Anforderung getestet werden.

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

Konfigurieren von Token-Einstellungen

Wenn der REST-Endpunkt ein Token für die Authentifizierung erfordert, führen Sie die folgenden Schritte aus, um die Web-Anforderungs-Vorlage für die Generierung eines Token zur Authentifizierung der Web-Anforderung zu konfigurieren.

1. Wählen Sie auf der Registerkarte Autorisierung die Option API-Schlüssel oder Bearer-Token aus, und klicken Sie auf Alternativ Token über Endpunkt generieren.

   Die Einstellungen Token über Endpunkt generieren werden im Fenster Web-Anforderung angezeigt.

2. Klicken Sie auf den Dropdown-Pfeil URL, und wählen Sie aus, welchen Anforderungstyp Sie senden möchten.
3. Geben Sie in das Textfeld URL die URL des REST-Endpunktes ein.
4. 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.

5. 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.
6. 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 ArcGIS Arcade-Ausdruck für das zugehörige Textfeld aus.

7. Optional klicken Sie auf die Registerkarte Header, um der Web-Anforderung benutzerdefinierte Header-Schlüssel/Wert-Paare hinzuzufü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.
8. 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.

9. Klicken Sie auf die Registerkarte Token.
10. Klicken Sie auf die Umschaltfläche Testmodus im Abschnitt Token.
11. 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
        }
      }
    ]}

12. Geben Sie in das Textfeld Ausgabewert einen Namen für das Token ein.

    Hierbei handelt es sich um den Namen, mit dem die Web-Anforderungs-Vorlage das generierte Token referenziert.

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

14. Klicken Sie auf Zurück, um mit der Konfiguration der Web-Anforderung fortzufahren.

Konfigurieren von Ausgabeeinstellungen

Lizenz:

Für diese Funktionalität ist eine Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced erforderlich.

Sie können die Antwort des REST-Endpunktes als Datei speichern, an die Vorlage anhängen und als benutzerdefinierte Ausgabewerte konfigurieren. Die Ausgabewerte können zum Festlegen von Workflow-Pfaden oder als Eingabewerte für Schritte verwendet werden. Wenn für die Vorlage kein Ausgabewert konfiguriert wird, wird der HTTP-Statuscode der Anforderung als Ausgabewert der Vorlage gespeichert. Führen Sie die folgenden Schritte aus, um die Ausgabeeinstellungen der Vorlage zu konfigurieren:

1. Klicken Sie auf die Registerkarte Ausgabe.
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. 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.
4. 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.
5. Klicken Sie auf Speichern, um die Änderungen zu speichern.

Bearbeiten von Web-Anforderungs-Vorlagen

Gehen Sie zum Bearbeiten von Web-Anforderungs-Vorlagen wie folgt vor:

1. Rufen Sie die Workflow Manager-Web-App auf.
2. Klicken Sie auf die Registerkarte Entwerfen.

   Die Seite Entwerfen wird angezeigt.

   Hinweis:

   Die Registerkarte Entwerfen ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

3. Klicken Sie auf Vorlagen .

   Hinweis:

   Vorlagen ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

4. Klicken Sie auf die Registerkarte Web-Anforderung.

   Daraufhin wird das Fenster Web-Anforderung angezeigt.

   Hinweis:

   Die Registerkarte Web-Anforderung ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

5. Klicken Sie auf den Namen der Web-Anforderung, die Sie im Fenster Web-Anforderung bearbeiten möchten.

   Tipp:

   Sie können die Liste der Web-Anforderungen im Fenster Web-Anforderung filtern, indem Sie einen Suchbegriff in das Textfeld Web-Anforderungs-Vorlagen suchen eingeben.

6. Aktualisieren Sie ggf. die Web-Anforderung.
7. Klicken Sie auf Speichern, um die Änderungen zu speichern.

Löschen von Web-Anforderungs-Vorlagen

Das Löschen einer Web-Anforderungs-Vorlage ist endgültig und kann nicht rückgängig gemacht werden. Gehen Sie zum Löschen von Web-Anforderungs-Vorlagen wie folgt vor:

1. Rufen Sie die Workflow Manager-Web-App auf.
2. Klicken Sie auf die Registerkarte Entwerfen.

   Die Seite Entwerfen wird angezeigt.

   Hinweis:

   Die Registerkarte Entwerfen ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

3. Klicken Sie auf Vorlagen .

   Hinweis:

   Vorlagen ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

4. Klicken Sie auf die Registerkarte Web-Anforderung.

   Daraufhin wird das Fenster Web-Anforderung angezeigt.

   Hinweis:

   Die Registerkarte Web-Anforderung ist nur verfügbar, wenn Sie über ausreichende Berechtigungen verfügen.

5. Klicken Sie auf den Namen der Web-Anforderung, die Sie im Fenster Web-Anforderung löschen möchten.

   Tipp:

   Sie können die Liste der Web-Anforderungen im Fenster Web-Anforderung filtern, indem Sie einen Suchbegriff in das Textfeld Web-Anforderungs-Vorlagen suchen eingeben.

6. Klicken Sie auf Weitere Aktionen und dann auf Löschen.

   Eine Bestätigungsmeldung wird angezeigt.

7. Klicken Sie auf Ja, um die Web-Anforderung zu löschen, oder auf Nein, um den Vorgang abzubrechen.