Erstellen von Aufträgen mit Webhooks

Lizenz:

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

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 ermöglicht es Ihnen, Informationen von eingehenden Webhooks zu verarbeiten, um Aufträge automatisch auf Basis der angegebenen Auftragsvorlage 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.

Erstellen eines eingehenden Webhook

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

1. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Hinweis:

   If you don't have sufficient privileges, the Design tab is not available.

3. Click the Job Templates button .

   The Job Templates panel appears.

4. Klicken Sie auf die Auftragsvorlage, für die Sie einen eingehenden Webhook erstellen möchten.

   Die Auftragsvorlage wird in dem Fenster angezeigt.

5. Click the Automated Actions tab.

   If you don't have a license for the ArcGIS Workflow Manager Server Advanced role or sufficient privileges, you can't configure automated actions.

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 konfigurieren Sie Ersatz-Anmeldeinformationen für den Webhook, indem Sie einen Benutzernamen und ein Kennwort in die Textfelder Fallback-Benutzername und Fallback-Kennwort eingeben.

   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. Um die Authentifizierung mit einem geheimem Schlüssel zu verwenden, aktivieren Sie Geheimer Header-Schlüssel, und geben Sie Werte für den geheimen Schlüssel in die Textfelder Schlüssel und Wert ein.
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. 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.
13. Führen Sie optional diese Schritte aus, um die Payload der eingehenden Webanforderung zu parsen und benutzerdefinierte Ausgabewerte zu konfigurieren:
    1. Klicken Sie auf die Umschaltfläche Testmodus im Abschnitt Ausgabewerte.
    2. 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
       },
       "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:

       $.spatialReference

       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.
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 die Schaltfläche URL kopieren , um die URL des eingehenden Webhook in die Zwischenablage zu kopieren und für die Verwendung in Ihrer Anwendung zu konfigurieren.

Bearbeiten eines Webhooks

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

1. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Hinweis:

   If you don't have sufficient privileges, the Design tab is not available.

3. Click the Job Templates button .

   The Job Templates panel appears.

4. Klicken Sie auf die Auftragsvorlage, die den eingehenden Webhook enthält, den Sie bearbeiten möchten.

   Die Auftragsvorlage wird in dem Fenster angezeigt.

5. Click the Automated Actions tab.

   If you don't have a license for the ArcGIS Workflow Manager Server Advanced role or sufficient privileges, you can't configure automated actions.

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 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. Access the Workflow Manager web app.
2. Click the Design tab.

   The Design page appears.

   Hinweis:

   If you don't have sufficient privileges, the Design tab is not available.

3. Click the Job Templates button .

   The Job Templates panel appears.

4. Klicken Sie auf die Auftragsvorlage, die den eingehenden Webhook enthält, den Sie löschen möchten.

   Die Auftragsvorlage wird in dem Fenster angezeigt.

5. Click the Automated Actions tab.

   If you don't have a license for the ArcGIS Workflow Manager Server Advanced role or sufficient privileges, you can't configure automated actions.

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.