Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
monday=12:00,13:00,15:31|tuesday=11:00,15:35|friday=13:00,15:35|firstdayofmonth=09:00|lastdayofmonth=23:59

 

URLTrigger - Flows per URL antriggern

Ab dem Starter-Paket ist es möglich, Flows per URL anzutriggern. Damit kann man durch Aufruf einer bestimmten URL z.B. durch externe Tools steuern, wann ein Flow ausgeführt wird. 

...


Mit diesem Mechanismus ergeben sich viele neue Möglichkeiten externe Anwendungen mit Synesty Studio zu kombinieren. Vorstellbar wäre z.B., dass sie bei jeder neuen Bestellung in ihrem Shop automatisch die Flow-URL aufrufen lassen (sofern ihr Shopsystem das erlaubt). Dieser Flow könnte dann diese neue Bestellung abrufen und z.B. in ihre Warenwirtschaft oder zu ihrem Lieferanten exportieren. 

Einrichtung
Neben dem Planen-Button finden Sie einen Button mit dem Sie den URLTrigger konfigurieren können. 

 

Image Modified

 

EinstellungBeschreibung
URLEine Vorschau der URL, die aufgerufen werden kann.
Short-URL

Sie haben die Möglichkeit einen eigenen Bezeichner zu definieren z.B. einen kurz einprägsamen Namen, über den der Flow angesprochen werden kann. Dieser Bezeichner muss systemweit eindeutig sein. Die Short-URL ist standardmäßig mit einer kryptischen langen Zufallszeichenfolge gefüllt. Ersetzen Sie diese einfach durch etwas entsprechenderes.

Sicherheits-Token

Eine Art Passwort, was mit dem Parameter &t= an die URL angefügt werden muss, um den Flow aufzurufen. Dies stellt eine zusätzliche Sicherheit dar. Nur wer die URL und den Token kennt, kann den Flow ausführen. Ändern Sie den Token regelmäßig ohne das sich die Short-URL ändert.
Sicherheitshinweis: Verwenden Sie immer einen Sicherheits-Token.

Info

Sie können auch eine Projekt-Variable referenzieren z.B. ${meineProjektVariable}, wenn Sie den Token für mehrere Flows an einer zentralen Stelle verwalten wollen.

(Wichtig: Projekt-Variable muss vom Eingabetyp Passwort-Feld sein)

Reponse Mode
  • URL Tirgger deaktiviert - in diesem Modus kann der Flow nicht über die URL aufgerufen werden.
  • JSON - beim Aufruf erhält der Aufrufende eine Antwort im JSON-Format. Diese Anwort enthält u.a. die RunID. Diese RunID kann in einer weiteren URL (URL for Status Check) genutzt werden, um den Status bzw. Fortschritt der Flowausführung zu prüfen.
  • Redirect - Anstatt einer JSON Antwort können Sie eine URL angeben, auf die ein Browser weitergeleitet werden soll. Es gibt eine URL sowohl für den Erfolgsfall (SUCCESS) oder Fehlerfall (ERROR). Diese Einstellung ist nur sinnvoll, wenn die Flow URL durch einen Browser aufgerufen wird bzw. durch einen Client, welcher HTTP-Redirects verarbeiten kann. Ein Einsatzbeispiel wäre, dass man den Besucher im Rahmen des Shop-Checkouts nach Bestellabschluss auf die Flow-URL schickt. Dadurch wird der Flow angetriggert. Mit Hilfe der Redirect-URL-SUCCESS kann man dann den Nutzer gleich wieder zurück in den Shop schicken. Es besteht die Möglichkeit die Flow-RunID an die Redirect-URL anzuhängen, um diesem dem Shopsystem mitzuteilen. Damit wäre das Shopsystem anschließend in der Lage über die URL for Status-Check den Fortschritt der Flowausführung abzufragen.
Request Mapping

siehe Request Mapping unten

Request Mapping

Mit dem Request Mapping kann man Flow-Variablen mit HTTP Request-Parametern befüllen. Das Request Mapping erlaubt es z.B. den kompletten HTTP-Request-Body in eine Flow-Variable zu füllen. Das ist nützlich wenn man den Flow-URL-Trigger als Webhook benutzt und eine JSON-Payload im Request-Body verarbeiten will.
Standardmäßig (ohne Request Mapping) werden all (public) Flow-Variablen durch gleichnamige HTTP-Request-Parameter (z.B. per URL) überschrieben. Wenn ein Request Mapping definiert ist, dann wird dieses stattdessen benutzt.


Beispiel:

Image Modified

Im Beispiel-Screenshot werden drei Flow-Variablen (jsonpayload, requestContentType, idFromURL) per Request Mapping an HTTP-Request-Parameter gebunden (gemappt).
Die Flow-Variable jsonpayload wird direkt mit dem kompletten HTTP-requestBody befüllt, requestContentType mit dem HTTP-Header "Content-Type" und die Flow-Variable idFromURL mit dem GET-Parameter id.

Vor allem die Verarbeitung des HTTP-RequestBody (body) ist praktisch, wenn in externen Applikationen Webhooks nutzen will. Viele Cloud-Dienste bieten heutzutage Webhooks, um andere Applikationen über bestimmte Ereignisse zu informieren und Daten zu synchronisieren. Dabei kann eine externe Applikation die Trigger-URL des Flows mit bestimmten Parametern aufrufen wenn bestimmte Ereignisse eintreten (z.B. neue Bestellung vorhanden). Diese übergebenen Parameter kann man mit per Request Mapping auslesen.

...

 

Beispiel - Flow per URL antriggern


Das ganze kann man einfach im Browser testen. 

...

Beim Abruf der Status-URL sieht man dann im Eventlog, dass jetzt die überschriebene URL verwendet wurde. 

Optionale Parameter

Der URL-Trigger verfügt über drei optionale Parameter die der URL angehängt werden können:

...