API-Zugriff auf Flows Workflow-Studio .

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 2 Minuten Lesedauer
  • Anwendungsentwickler können über-APIs für Abläufe, Unterabläufe und Aktionen auf die Workflow-Studio-Funktionalität zugreifen. Flow-Autoren können während des Designs einzelne Flows, Subflows und Aktionen als vom Client aufrufbar aktivieren.

    Verfügbare Workflow-Studio Flow-APIs

    Auslöserabläufe, -unterabläufe und -aktionen, die diese APIs von Server- oder Clientskripts verwenden.

    Serverseite
    FlowAPI: Löst einen Flow, einen Subflow oder eine Aktion mithilfe synchroner oder asynchroner Methoden mit oder ohne Ausführungsdetails aus.
    Client-Seite
    GlideFlow: Führen Sie clientseitige Interaktionen mit Aktionen, Flows und Subflows aus. Flow-Designer müssen Abläufe, Unterabläufe und Aktionen aktivieren, damit sie vom Client aufgerufen werden können.

    FlowAPI-Schnellmethoden

    Verwenden Sie Schnellmethoden in der FlowAPI -Klasse, um eine Aktion, einen Flow oder einen Subflow aus einem serverseitigen Skript auszuführen, ohne Ausführungsdetails oder andere zugehörige Datensätze zu erstellen. Verwenden Sie diese Methoden, um die Geschwindigkeit der Verarbeitung großer Mengen in einer Produktionsumgebung zu erhöhen und die Leistung zu verbessern, indem Sie den Aufwand für die Datensatzverwaltung eliminieren. Zu den Methoden gehören:

    • executeActionQuick(), executeFlowQuick(), executeSubflowQuick(): Führen Sie eine Aktion, einen Flow oder einen Subflow aus einem serverseitigen Skript synchron zur aktuellen Anwendersitzung aus.
    • startActionQuick(), startFlowQuick(), startSubflowQuick(): Führen Sie eine Aktion, einen Flow oder einen Subflow asynchron aus einem serverseitigen Skript aus.

    XML- und JSON-Streaming-APIs

    Erstellt eine große Streaming- oder Nicht-Streaming-JSON- oder XML-Nutzlast, die in einer REST- oder SOAP-Anforderung zum Senden von Massendaten an eine Drittanbieter-API verwendet wird. Sie können diese APIs beispielsweise verwenden, um im Skriptschritt Workflow-Studio eine JSON-Nutzlast zu erstellen und den zurückgegebenen Wert an den REST-Schritt zu übergeben, um die Anforderung an einen Drittanbieterservice zu senden. Weitere Informationen finden Sie unter JSONStreamingBuilder und XMLStreamingBuilder .

    APIs für aufrufbare Clientelemente

    Standardmäßig können die Abläufe, Unterabläufe und Aktionen nur von der FlowAPI in einem Serverskript aufgerufen werden. Flow- und Aktionsdesigner können einzelne Flows, Subflows oder Aktionen für Client-Aufrufe verfügbar machen, indem sie während des Designprozesses die Option Vom Client aufrufbar aktivieren.

    Als Unterstützung ausführen

    Flows und Subflows können entweder als Systembenutzer oder als Benutzer, der die Sitzung initiiert, ausgeführt werden. Legen Sie dieses Verhalten in den Flow-Eigenschaften fest. Alle API-Schnellmethoden ignorieren die Eigenschaft „Ausführen als“ und werden immer als Systembenutzer ausgeführt.

    Aktionen werden immer als der Benutzer ausgeführt, der die Sitzung initiiert.

    Codeausschnitte

    Anwendungsentwickler können mit der Option Code -Fragment eine JavaScript-Funktion generieren, die einen bestimmten Flow, Subflow oder eine bestimmte Aktion aufruft. Verwenden Sie das Code-Fragment in Skripts wie Business-Regeln oder dem Modul Skripts – Hintergrund, um bestimmte Workflow-Studio -Elemente aufzurufen. Das System generiert nur Codeausschnitte für veröffentlichte Abläufe, Unterabläufe und Aktionen. Workflow-Studio-Elemente im Status „Entwurf“ oder „Geändert“ generieren keine Codeausschnitte.