API-Zugriff auf Flow Designer

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 2 Minuten Lesedauer

    • Anwendungsentwickler können über-APIs für Abläufe, Unterabläufe und Aktionen auf die Flow Designer-Funktionalität zugreifen. Flow-Designer können einzelne Abläufe, Unterabläufe und Aktionen während des Designs als aufrufbares Clientelement aktivieren.

    Verfügbare Flow Designer-APIs

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

    Serverseite
    FlowAPI: Sie lösen einen Flow, einen Subflow oder eine Aktion mit synchronen oder asynchronen 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 von einem serverseitigen Skript aus 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 Overhead für die Datensatzverwaltung eliminieren. Zu den Methoden gehören:

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

    XML- und JSON-Streaming-APIs

    Erstellen Sie eine große JSON- oder XML-Nutzlast für Streaming oder Nicht-Streaming, die in einer REST- oder SOAP-Anforderung zum Senden von Massendaten an eine Drittanbieter-API verwendet werden soll. Beispielsweise können Sie diese APIs verwenden, um eine JSON-Nutzlast im Skriptschritt ServiceNow® Flow Designer 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 Support ausführen

    Flows und Subflows können entweder als Systembenutzer oder als Benutzer ausgeführt werden, der die Sitzung initiiert. 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 eine JavaScript-Funktion generieren, die einen bestimmten Flow, Subflow oder eine Aktion mit der Option Code Snippet aufruft. Verwenden Sie das Code-Fragment in Skripts wie Business Rules oder dem Modul „ Skripts – Backgound“, um bestimmte Flow Designer -Elemente aufzurufen. Das System generiert nur Codeausschnitte für veröffentlichte Abläufe, Unterabläufe und Aktionen. Flow Designer-Elemente im Status „Entwurf“ oder „Geändert“ generieren keine Codeausschnitte.