App-Nutzung im Bot Builder

Im Bot Builder werden die Module einer App auf der rechten Seite bei den Schritten aufgeführt. Die Module sind gebündelt unter dem Abschnitt mit der Überschrift des App-Namens aufgelistet und können von dort in den Flow gezogen werden.

App-Modul ausführen

Ein App wird wie ein normaler Step in den Flow integriert und dort ausgeführt auch ausgeführt. Zunächst muss das App-Modul (falls notwendig) mit den benötigten Parameter gefüllt werden und anschließend kann über den Output (bzw. die App-Modul Variablen) die Rückgabe weiterverarbeitet werden.

Beispiel Nutzung App-Modul "GetJokeByCategory"

Werte/Parameter übergeben

In den darunter liegenden Felder werden die Parameter des Moduls (der spezifischen HTTP-Abfrage) in Form von Eingabefeldern aufgelistet. Die Felder müssen, wenn sie mit (*) als notwendig gekennzeichnet sind, mit den entsprechenden Werten des Flows gefüllt werden. Hierzu wählt man die entsprechenden Variablen aus oder übergibt feste Werte als direkte Eingabe.

Werte/Parameter übergeben

Hierfür können natürlich auch Entitäten, andere Variablen oder Ähnliches verwendet werden.

Rückgabewerte weiterverarbeiten

Nachdem ein Modul im Flow durchlaufen wurde, werden die Rückgabewerte in den Variablen der entsprechenden App gespeichert. Von dort aus kann man auf die Daten/Werte zugreifen und diese im Flow weiterverarbeiten.

Auswahl der App-Modul-Variablen (flache Datenstruktur)

Bei einer flachen Datenstruktur des Outputs werden alle Variablen auf einer Ebene ohne Einrückungen dargestellt.

Auswahl der Rückgabewert (flache Datenstruktur)

Auswahl der App-Modul-Variablen (verschachtelte Datenstruktur)

Bei einer verschachtelte Datenstruktur des Outputs werden die Variablen auf unterschiedlichen Ebenen dargestellt. Auf der ersten Ebene befinden sich normale flache Objekte und eingerückt befinden sich die verschachtelten Objekte. In dem folgenden Beispiel sind dem übergeordneten Objekt "Adresse" die Objekte Stadt, Strasse, Hausnummer und Postleitzahl untergeordnet und werden dementsprechend eingerückt dargestellt. Das übergeordnete Objekt "Adresse" ist selber nicht wählbar. Dieses App-Modul und der Output basiert auf Dummy - Beispiel Output-Definition (verschachtelte JSON-Datenstruktur).

Auswahl der Rückgabe (verschachtelte Datenstruktur)

Darstellung der App-Modul-Variablen

Die Variablen eines App-Moduls werden nach folgender Struktur dargestellt:

"App Name - Module Name - Pfad Output"

Hierbei entspricht der "Pfad Output" der Struktur der Objekte im Output. Bei einer flachen Datenstruktur entspricht der "Pfad Output" dem einfachen Namen des Objektes. Bei einer verschachtelten Datenstruktur wird hingegen der Pfad durch alle übergeordneten Objekte hin bis zum endgültigen Objekt angezeigt. Zur Verdeutlichung sind für die beiden Strukturtypen Beispiele aufgeführt:

Darstellung der App-Modul-Variablen (flache Datenstruktur)

Darstellung der App-Modul-Variablen (verschachtelte Datenstruktur)

Beispiel Nutzung eines App-Modules

Bei diesem Beispiel handelt es sich um den Flow-Ausschnitt der in den vorherigen Punkten erläutert wurde. Die Benutzereingabe wird als Werte/Parameter an das App-Modul übergeben und dieses wird anschließend ausgeführt.

Beispiel Flow-Ausschnitt