Verwalten von API-Triggern

Erstellen eines API-Triggers

1. Navigieren Sie in einem Ordner zu Automatisierungen > Trigger > API-Trigger.
2. Klicken Sie auf Neuen Trigger hinzufügen. Das Fenster Neuen API-Trigger erstellen wird angezeigt.
3. Wählen Sie im Dropdownmenü Prozessname einen zugrunde liegenden Prozess für Ihren Trigger aus.
4. Das Feld Name wird mit dem Prozessnamen vorab ausgefüllt, gefolgt vom Triggertyp im Format <ProcessName>_<TriggerType>. Der Triggername kann jedoch mit einem anderen Namen bearbeitet werden, falls dies gewünscht wird.
5. Wählen Sie im Dropdownmenü Auftragspriorität die Priorität des Auftrags aus. Der Standardwert ist Geerbt, was bedeutet, dass die Auftragspriorität mit der für den ausgewählten Prozess definierten übereinstimmt.
6. Wählen Sie im Dropdownmenü Runtime-Typ die Runtime aus, die zum Ausführen der Aufträge verwendet wird, die vom Trigger gestartet werden.
7. Geben Sie auf der Registerkarte Argumente Werte für Eingabeargumente an, wenn Ihr Prozess welche hat. Weitere Informationen erhalten Sie bei: Über Eingabe- und Ausgabeargumente.
8. Wählen Sie im Dropdownmenü Verb die Option aus, die die Aktion beschreibt, die Ihr Auftrag ausführen soll: DELETE, GET, POST und PUT.
9. Geben Sie im Feld Slug eine Slug ein, die an die Basis-URL angehängt wird, wodurch die endgültige URL für den resultierenden Endpunkt generiert wird, den Sie in Ihrer Anwendung verwenden werden. Sie können eine Vorschau der vollständigen URL unter diesem Feld sehen.
   Die Standard-Slug ist ${Process_Name}, aber Sie können sie anpassen, um die Eindeutigkeit auf Mandantenebene sicherzustellen.

   Beachten Sie, dass Schrägstriche nicht unterstützt werden.

10. Wählen Sie im Dropdownmenü Standardanrufmodus den gewünschten Anrufmodus aus. Die verfügbaren Optionen sind:

    • Asynchrones Abruf (dies ist die Standardeinstellung, kann aber geändert werden)

    • Asynchrones Fire-and-Forget

    • Synchronisierung (Long Polling)

    Weitere Informationen zu diesen Optionen finden Sie unter Starten eines Auftrags über einen API-Trigger.

11. Aktivieren Sie den Umschalter Beenden der Auftragsausführung planen, um eine Auftragsbeendigungsstrategie auszuwählen.
    Hinweis:

    • Der hier angegebene Zeitraum vergeht gemäß den Vorgaben, auch wenn sich der Auftrag in einer Warteschlange befindet. Wenn Sie beispielsweise die Ausführung eines Auftrags für 13:00 Uhr geplant haben und einstellen, dass er nach 20 Minuten anhalten soll, dann hält der Auftrag um 13:20 Uhr an, selbst wenn er sich bis 13:15 Uhr in einer Warteschlange befand und erst dann gestartet wurde.
    • Die Optionen Beenden der Auftragsausführung planen eines Triggers werden für manuell gestartete Aufträge beibehalten.

    Angenommen, Sie haben den Trigger „T1“ erstellt und die folgenden Zeitpläne für das Auftragsende aktiviert:

    • Beenden der Auftragsausführung planen: Einen Auftrag nach 10 Minuten anhalten

    • Automatisches Beenden planen, wenn der Auftrag nicht angehalten wird: Auftrag nach zwei Minuten beenden

      Wenn Sie auf der Seite Automatisierungen > Trigger für den Trigger T1 auf Einen Auftrag jetzt starten klicken, wird die Seite Auftrag starten mit den bereits angewendeten Zeitplänen für die Auftragsbeendigung geöffnet – den gleichen, die Sie beim Erstellen des Triggers konfiguriert haben.

    Wenn Sie außerdem planen, einen ausstehenden oder laufenden Auftrag nach 2 Stunden zu beenden und auch so zu konfigurieren, dass derselbe Auftrag nach 3 Stunden beendet wird, wird der Auftrag nach 5 Stunden beendet. Dies geschieht, weil zunächst das Signal an den Orchestrator gesendet wird, dass der Auftrag nach 2 Stunden tatsächlich angehalten wurde. Sobald das Signal empfangen wurde, wird die Aktion „Auftrag beenden“ ausgelöst, die innerhalb von 3 Stunden ausgeführt wird, wodurch sich insgesamt 5 Stunden ergeben.

    • Wählen Sie Anhalten aus der Dropdownliste aus – es wird versucht, die Ausführung ordnungsgemäß zu beenden, nachdem das definierte Zeitintervall vergangen ist, weil der Auftrag im Status „Ausstehend“ oder „Wird ausgeführt“ festhängt (legen Sie die Zeit auf ein Minimum von 1 Minute, maximal 10 Tage, 23 Stunden und 59 Minuten fest);
      Beispiel: Der Orchestrator wird versuchen, Aufträge anzuhalten, die für mindestens 10 Minuten im Status „Ausstehend“ oder „Wird ausgeführt“ feststecken.

      

    • Wählen Sie Beenden aus der Dropdownliste aus – es wird versucht, die Ausführung zwangsweise zu beenden, nachdem das definierte Zeitintervall vergangen ist, weil der Auftrag im Status „Ausstehend“ oder „Wird ausgeführt“ feststeckt (legen Sie die Zeit auf ein Minimum von 1 Minute, maximal 10 Tage, 23 Stunden und 59 Minuten fest);

      Beispiel: Der Orchestrator wird versuchen, Aufträge zu beenden, die mindestens 10 Minuten lang im Status „Ausstehend“ oder „Wird ausgeführt“ feststecken.

    • Wählen Sie Anhalten aus der Dropdown-Liste aus, und aktivieren Sie die Option Wenn der Auftrag nicht anhält, soll er beendet werden – es wird versucht, die Ausführung ordnungsgemäß zu beenden, nachdem das definierte Zeitintervall vergangen ist, weil sich der Auftrag im Status „Ausstehend“ oder „Wird ausgeführt“ befindet, und dann wird versucht, ihn zwangsweise zu beenden, nachdem das definierte Zeitintervall vergangen ist, weil sich der Auftrag im Status „Anhalten“ befindet (legen Sie die Zeit auf mindestens 1 Minute fest, maximal 10 Tage, 23 Stunden und 59 Minuten).

      Beispiel: Der Orchestrator versucht, Aufträge anzuhalten, die sich für mindestens 10 Minuten im Status „Ausstehend“ oder „Wird ausgeführt“ befinden. Wenn das Beenden nicht erfolgt, versucht der Orchestrator, die Aufträge zu beenden, die sich mindestens 20 Minuten lang im Status „Wird angehalten“ befinden.

12. Verwenden Sie den Umschalter Automatische Trigger-Deaktivierung planen und geben Sie das Datum und die Uhrzeit für die Deaktivierung des Triggers ein. Die ausgewählte Zeitzone beeinflusst, wann der Zeittrigger deaktiviert wird.
13. Aktivieren Sie den Umschalter Eine Warnung generieren, wenn der Auftrag hängen bleibt (im Status „Ausstehend“ oder „Fortgesetzt“) und legen Sie die akzeptable Dauer fest, die der Auftrag im Status „Ausstehend“ oder „Fortgesetzt“ bleiben soll. Die konfigurierbare Mindestdauer beträgt eine Minute. Die maximal konfigurierbare Dauer beträgt elf Tage. Wenn der Auftrag die konfigurierte Dauer überschreitet, werden Sie in einem Popup-Fenster mit der Schweregradwarnung „Fehler“ mit dem folgenden Text darüber informiert: „N Aufträge für #Prozess {process_number} sind seit mehr als X Stunden und Y Minuten ausstehend bzw. wurden fortgesetzt.", wobei:
    • N – ist die Anzahl der Aufträge, die die Warnung ausgelöst haben;
    • {process_number} – die Prozess-ID;
    • X - die konfigurierte Anzahl von Stunden, die der Auftrag überschritten hat, während er den Status „Ausstehend“ oder „Fortgesetzt“ hatte; Tage werden in Stunden konvertiert.
    • Y – Die konfigurierte Anzahl von Minuten, die der Auftrag im Status „Ausstehend“ oder „Fortgesetzt“ überschritten hat.
14. Aktivieren Sie den Umschalter Warnung generieren, wenn der Auftrag gestartet und nicht abgeschlossen wurde und legen Sie die akzeptable Dauer für den Abschluss des Auftrags fest. Die konfigurierbare Dauer beträgt mindestens eine Minute und maximal elf Tage. Wenn der Auftrag die konfigurierte Dauer überschreitet, werden Sie in einem Popup-Fenster mit der Schweregradwarnung „Fehler“ mit dem folgenden Text darüber informiert: „Der Auftrag für #Prozess {process_number} läuft seit mehr als X Stunden und Y Minuten.“ Wo:
    • {process_number} – die Prozess-ID;
    • X - die konfigurierte Anzahl von Stunden, die der Auftrag beim Abschlussversuch überschritten hat; Tage werden in Stunden konvertiert.
    • Y – Die konfigurierte Anzahl von Minuten, die der Auftrag beim Versuch, ihn abzuschließen, überschritten hat.
15. Aktivieren Sie den Umschalter Deaktivierung von ausführungsbasierten Triggern festlegen, wenn Sie steuern möchten, wann der Trigger deaktiviert wird, sobald ein Auftrag fehlschlägt. Dieser Umschalter zeigt zwei Optionen an:

    Option	Beschreibung
    Deaktivieren, wenn die Zählung der aufeinanderfolgenden Auftragsausführungen fehlschlägt	Der Trigger wird nach der Anzahl fehlgeschlagener Ausführungen deaktiviert, die Sie für diese Einstellung wählen. Sie können einen Wert zwischen 0 und 100 wählen. Der Standardwert ist 0, was bedeutet, dass der Trigger nie deaktiviert wird. Angehaltene Aufträge werden bei diesem Wert nicht mitgezählt.
    Übergangszeitraum beim Deaktivieren des Triggers (Tage)	Die Anzahl der zu wartenden Tage, bevor der Trigger nach dem ersten Fehlschlag eines Auftrags deaktiviert wird. Sie können einen Wert zwischen 0 und 30 wählen. Der Standardwert ist 0, d. h., der Trigger wird deaktiviert, sobald die im obigen Feld festgelegte Anzahl von Auftragsausführungen für den aktuellen Tag erreicht ist.

    Hinweis:

    Wenn Sie eine Cloud – Serverless-Runtime für den zugrunde liegenden Prozess auswählen, wird die Option Deaktivierung von ausführungsbasierten Triggern festlegen automatisch mit den folgenden Standardwerten aktiviert (die Felder sind schreibgeschützt):

    • Die Option Deaktivieren, wenn die Zählung der aufeinanderfolgenden Auftragsausführungen fehlschlägt ist auf 10 festgelegt.

    • Der Übergangszeitraum beim Deaktivieren des Triggers (Tage) ist auf 0 festgelegt.

    Dies gilt nur für Sie, wenn Sie sich im Community-Lizenzierungsplan befinden.

16. Um den gleichen Konto-Maschinen-Kontext für den Start des Auftrags konfiguriert zu halten, aktivieren Sie das Kontrollkästchen Konto-/Maschinenzuweisung bei Wiederaufnahme des Auftrags beibehalten. Dadurch wird Ihre Lizenz- und Ressourcennutzung optimiert.

Wichtig:

• Ausführungseinstellungen auf Mandantenebene gelten für API-Trigger.

• Sie können maximal 1.000 API-Trigger pro Mandant erstellen.

Aktionen für API-Trigger

Auf der Seite API-Trigger können Sie mehrere Aktionen über das Kontextmenü jedes Triggers ausführen:

Vollständige Slug-URL kopieren

Kopieren Sie die URL, die in der Drittanbieteranwendung verwendet werden soll.

Ein API-Trigger mit der Slug hw-process sieht folgendermaßen aus: https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process

Bearbeiten

Ändern Sie die Eigenschaften des ausgewählten API-Triggers.

Slug kopieren

Kopieren Sie due Slug im entsprechenden Format zur Verwendung in der Befehlszeile oder in vorhandenem Code. Die verfügbaren Optionen sind:

Als curl (bash) kopieren – Für einen API-Trigger mit der Slug hw-process sieht es folgendermaßen aus:

curl '{baseURL_orchestrator}/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process'  -X 'POST'  -H 'Content-Type: application/json'  -H 'Authorization: Bearer ***INSERT_YOUR_TOKEN***'

Als curl (cmd) kopieren – Für einen API-Trigger mit der Slug hw-process sieht es folgendermaßen aus:

curl "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ^ -X "POST" ^ -H "Content-Type: application/json" ^ -H "Authorization: Bearer ***INSERT_YOUR_TOKEN***"

Als Abruf kopieren – Für einen API-Trigger mit dem Slug hw-process sieht es so aus:

fetch("https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process", { headers: { Authorization: "Bearer ***INSERT_YOUR_TOKEN***", "Content-Type": "application/json" }, "method": "POST" })

Als PowerShell kopieren – Für einen API-Trigger mit der Slug hw-process sieht es folgendermaßen aus:

$headers = @{ "method"="POST" "Authorization" = "Bearer ***INSERT_YOUR_TOKEN***" } Invoke-WebRequest -UseBasicParsing -Uri "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ` -Headers $headers ` -ContentType "application/json"

Aktivieren

Aktiviert einen zuvor deaktivierten API-Trigger.

Deaktivieren

Deaktivieren Sie einen bereits aktivierten API-Trigger.

Entfernen

Entfernen Sie den ausgewählten API-Trigger. Das Löschen eines API-Triggers entspricht dem Löschen des resultierenden Endpunkts. Je nach Szenario können Sie folgende Verhaltensweisen erwarten:

Aufträge wurden bereits gestartet

Wenn ein Auftrag, der auf einem Prozess basiert, der einem gelöschten API-Trigger zugeordnet ist, zum Zeitpunkt der Löschung bereits gestartet ist, wird er vollständig ausgeführt.

Starten neuer Aufträge

Da die URL nicht mehr verfügbar ist, führt der Versuch, einen Auftrag basierend auf einem Prozess zu starten, der einem gelöschten API-Trigger zugeordnet ist, zu einem 404-Fehler.

Bearbeiten von Prozessen

Wenn Sie einen Prozess bearbeiten, der von mindestens einem API-Trigger verwendet wird, wird der Trigger aktualisiert und der neue Satz von Prozesseigenschaften angewendet.

Ressourcenfreigabe zwischen verschiedenen Quellen

Sie können Domänen zur Zulassungsliste für eingehenden Datenverkehr hinzufügen, indem Sie die Option CORS-Zulassungsliste für API-Trigger auf der Registerkarte Allgemein Ihrer Mandanteneinstellungen verwenden.

Dies ist für Browseranwendungen erforderlich, die HTTP-Anforderungen an den Orchestrator über Ihren Browser stellen (d. h. nicht von einem Server). Wenn Domänen nicht auf die Zulassungsliste gesetzt werden, kann dies zu einem CORS-Richtlinienfehler führen, den Sie in Ihrer Entwicklerkonsole sehen können.

Wenn Sie weitere Domänen auf die Zulassungsliste setzen möchten, verwenden Sie ein Komma oder drücken Sie die Eingabetaste, um sie zu trennen.

API-Definition

Auf dieser Seite wird eine Swagger-Definition der von Ihnen erstellten API-Trigger gruppiert nach Ordnern zusammen mit deren Ausgabe angezeigt. Darüber hinaus können Sie die Aufträge ausführen, die zu diesen Triggern gehören.

Der Zugriff kann durch Klicken auf die Schaltfläche API-Definition auf der Seite API-Trigger oder über https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/swagger/index.html. erfolgen.

Die API-Definition für einen Mandanten mit API-Triggern in einem persönlichen Arbeitsbereich und im Ordner Freigegeben sieht folgendermaßen aus: