Erstellen von Aufträgen mit Webhooks

Lizenz:

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

Webhooks ermöglichen es Anwendungen, Informationen an andere Anwendungen und Services zu senden, wenn eine bestimmte Aktion oder ein bestimmtes Ereignis eintritt. ArcGIS Workflow Manager agiert als Empfänger der Webhook-Payload und ermöglicht es Ihnen, Informationen von einem eingehenden Webhook zu verarbeiten, um auf Basis der angegebenen Auftragsvorlage automatisch einen Auftrag zu erstellen. Sie können auch die Payload des eingehenden Webhook als Datei speichern und an den Auftrag anhängen sowie benutzerdefinierte Ausgabewerte konfigurieren, die während des gesamten Auftrags verwendet werden können.

Ab Version 11.2 ist für alle eingehenden Webhooks Header-Sicherheit erforderlich. Um in Workflow Manager die Verwendung von Webhooks ohne Header-Sicherheit zuzulassen, müssen Sie die Eigenschaft allowUnsecureWebhooks in der Workflow Manager-Konfigurationsdatei auf true festlegen.

Vorsicht:

Vorhandene Webhooks funktionieren erst, wenn für das Workflow-Element ein Upgrade auf die neueste Version durchgeführt wurde.

Erstellen eines eingehenden Webhooks

Führen Sie diese Schritte aus, um einen eingehenden Webhook 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 Auftragsvorlagen .

   Das Fenster Auftragsvorlagen wird angezeigt.

4. Wählen Sie die Auftragsvorlage aus, für die Sie einen eingehenden Webhook erstellen möchten.

   Die Auftragsvorlage wird in dem Fenster angezeigt.

5. Klicken Sie auf die Registerkarte Automatisierte Aktionen.

   Automatisierte Aktionen können Sie nur konfigurieren, wenn Sie über eine Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced oder über ausreichende Berechtigungen verfügen.

6. Klicken Sie im Abschnitt Webhook-Auftragserstellung auf Webhook hinzufügen.

   Das Dialogfeld Webhook erstellen wird angezeigt.

7. Geben Sie in das Textfeld Name einen Namen für den Webhook ein.
8. Geben Sie einen Benutzernamen und ein Kennwort in die Textfelder Benutzername und Kennwort ein, um Anmeldeinformationen für den eingehenden Webhook zu erstellen.

   Sie können auch einen ArcGIS Arcade-Ausdruck in den Textfeldern Benutzername und Kennwort verwenden, um diese Werte mithilfe verschlüsselter benutzerdefinierter Einstellungen dynamisch eintragen zu lassen.

   Vorsicht:

   Informationen, die Sie in die Textfelder Benutzername und Kennwort eingeben, werden nicht verschlüsselt. Es wird empfohlen, dass Sie verschlüsselte benutzerdefinierte Einstellungen erstellen, um Webhook-Anmeldeinformationen sicher zu speichern.

   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.

9. Aktivieren Sie optional Fallback-Benutzername und -Kennwort, und geben Sie in den Textfeldern Fallback-Benutzername und Fallback-Kennwort Ersatz-Anmeldeinformationen an.

   Sie können auch einen ArcGIS Arcade-Ausdruck in den Textfeldern Benutzername und Kennwort verwenden, um diese Werte mithilfe verschlüsselter benutzerdefinierter Einstellungen dynamisch eintragen zu lassen.

   Vorsicht:

   Informationen, die Sie in die Textfelder Fallback-Benutzername und Fallback-Kennwort eingeben, werden nicht verschlüsselt. Es wird empfohlen, dass Sie verschlüsselte benutzerdefinierte Einstellungen erstellen, um Webhook-Anmeldeinformationen sicher zu speichern.

10. Wählen Sie im Abschnitt Header-Sicherheit eine Authentifizierungsmethode aus:

    Hinweis:

    Für eingehende Feature-Service-Webhooks muss die Authentifizierungsmethode ArcGIS-Webhook verwendet werden.

    • Einfach: Validiert eine eingehende Anforderung, indem der definierte Header mit dem Secret abgeglichen wird.

      Geben Sie in den Textfeldern Header-Name und Wert Authentifizierungswerte an.

    • ArcGIS-Webhook: Validiert eine eingehende Anforderung durch Abgleich mit einer Hash-Funktion, die aus einem gemeinsamen geheimen Schlüssel generiert wird.

      Geben Sie im Textfeld Secret einen Wert an.

11. Klicken Sie optional auf die Registerkarte Payload, und aktivieren Sie Antwort anhängen, um die Payload des eingehenden Webhook als Datei zu speichern und an den Auftrag anzuhängen.
12. 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 keinen Dateisystempfad und keine Sonderzeichen enthalten. Wird kein Ordnername angegeben, so 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.
13. Führen Sie optional diese Schritte aus, um die Payload des eingehenden Webhooks zu parsen und benutzerdefinierte Ausgabewerte zu konfigurieren:
    1. Wenn es sich bei der Quelle des eingehenden Webhooks um einen Feature-Service-Webhook handelt, können Sie optional Änderungen extrahieren aktivieren, um die extrahierten Änderungen in Ihren Ausgabewerten zu verwenden.
    2. Klicken Sie auf die Umschaltfläche Testmodus im Abschnitt Ausgabewerte.
    3. Fügen Sie ein Beispiel für die Payload des eingehenden Webhook in das Textfeld Beispielantwort ein.

       Beispiel-Payload im JSON-Format:

       {"spatialReference": {
         "wkid": 4326,
         "latestWkid": 4326
       },
       "location": [
         {
           "name": "380 New York Street",
           "extent": {
             "xmin": -117.196701,
             "ymin": 34.055489
           }
         }
       ]}

    4. Klicken Sie auf Ausgabe und Pfad hinzufügen.
    5. 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.

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

    7. Wiederholen Sie bei Bedarf die Teilschritte c bis f, um weitere benutzerdefinierte Ausgabewerte hinzuzufügen.
14. Klicken Sie auf Speichern.

    Der eingehende Webhook wird im Abschnitt Webhook-Auftragserstellung angezeigt.

15. Klicken Sie auf Speichern, um die Auftragsvorlage zu speichern.

    Dem Webhook wird eine ID und eine URL zugewiesen.

16. Zeigen Sie mit der Maus auf den Webhook, und klicken Sie auf URL kopieren , um die URL des eingehenden Webhooks in die Zwischenablage zu kopieren und für die Verwendung in Ihrer Anwendung zu konfigurieren.

Bearbeiten eines eingehenden Webhooks

Führen Sie diese Schritte aus, um einen eingehenden Webhook zu bearbeiten:

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

   Das Fenster Auftragsvorlagen wird angezeigt.

4. Wählen Sie die Auftragsvorlage aus, die den eingehenden Webhook enthält, den Sie bearbeiten möchten.

   Die Auftragsvorlage wird in dem Fenster angezeigt.

5. Klicken Sie auf die Registerkarte Automatisierte Aktionen.

   Automatisierte Aktionen können Sie nur konfigurieren, wenn Sie über eine Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced oder über ausreichende Berechtigungen verfügen.

6. Zeigen Sie im Abschnitt Webhook-Auftragserstellung mit der Maus auf den eingehenden Webhook, den Sie bearbeiten möchten, und klicken Sie auf Bearbeiten.

   Das Dialogfeld Webhook erstellen wird angezeigt.

7. Aktualisieren Sie die Einstellungen des eingehenden Webhooks nach Bedarf.
8. Klicken Sie auf Speichern, um die Änderungen zu speichern.
9. Klicken Sie auf Speichern, um die Auftragsvorlage zu speichern.

   Der eingehende Webhook wird aktualisiert.

Löschen eines eingehenden Webhooks

Das Löschen eines eingehenden Webhooks ist dauerhaft und kann nicht rückgängig gemacht werden. Führen Sie diese Schritte aus, um einen eingehenden Webhook zu löschen:

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

   Das Fenster Auftragsvorlagen wird angezeigt.

4. Wählen Sie die Auftragsvorlage aus, die den eingehenden Webhook enthält, den Sie löschen möchten.

   Die Auftragsvorlage wird in dem Fenster angezeigt.

5. Klicken Sie auf die Registerkarte Automatisierte Aktionen.

   Automatisierte Aktionen können Sie nur konfigurieren, wenn Sie über eine Lizenz für die Rolle ArcGIS Workflow Manager Server Advanced oder über ausreichende Berechtigungen verfügen.

6. Zeigen Sie im Abschnitt Webhook-Auftragserstellung mit der Maus auf den eingehenden Webhook, den Sie löschen möchten, und klicken Sie auf Webhook löschen .

   Vorsicht:

   Gelöschte eingehende Webhooks können nicht wiederhergestellt werden.

7. Klicken Sie auf Speichern, um die Auftragsvorlage zu speichern.

   Der Webhook wird gelöscht.