Erfahren Sie, wie Sie die Ausgaben von HTTP-Konnektoren strukturieren.
Übersicht
Mit dem Konnektorfunktions-Editor in Tulip können Sie die von Ihren Konnektorfunktionen zurückgegebenen Daten so strukturieren, dass sie in Ihren Anwendungen nützlich und nutzbar sind. In diesem Artikel behandeln wir die Grundlagen der Formatierung von Outputs von Konnektorfunktionen und stellen Ihnen Folgendes vor:
- Das Konzept einer Connector-Ausgabe
- Verfügbare Werkzeuge zur Formatierung von Ausgabedaten
- Verschiedene gängige Ausgabeformate
Was sind Ausgänge?
Ausgaben dienen dazu, die Rückgabewerte der Connector-Funktion zu definieren und zu strukturieren. Mit ihrer Hilfe extrahieren Sie die für Ihre Apps wichtigen Informationen aus einem größeren HTTP-Rückgabetext.
So strukturieren Sie Ausgabedaten
Suchen Sie den Abschnitt „Ausgaben“ unten links im Connector-Funktions-Editor.
Um mit dem Hinzufügen von Ausgängen zu beginnen, klicken Sie auf „Funktionsausgänge hinzufügen“.
Es empfiehlt sich, Ihren Ausgängen einen aussagekräftigen Namen zu geben. Diese Namen werden in Apps als Variablen angezeigt, daher ist es wichtig, dass sie sich voneinander unterscheiden lassen.
Um die Ergebnisse einer HTTP-Anfrage zu verstehen, ist es wichtig, zunächst die Struktur eines Objekts zu kennen, das in den Testergebnissen zurückgegeben wird. Das folgende Diagramm veranschaulicht, wie die Ergebnisse in Abschnitte mit Objekten und Arrays unterteilt sind.
If you haven’t worked with JSON before, you may be unfamiliar with two critical datatypes, objects and arrays. Arrays are lists of values of the same type. For example, [1,2,3,5], or [oak, elm, alder, hickory]. Values in arrays are contained within square brackets, [ ]. Objects are a datatype for holding key:value pairs. The key:value pairs within an object can be of multiple different types, including arrays and nested objects. Objects are contained with curly brackets, { }.
Weitere Informationen zu Objekten und Arrays finden Sie unter „Arrays und Objekte in den Ausgaben von Connector-Funktionen verstehen“.
Punktnotation
Bei HTTP-Konnektoren verwenden die Ausgaben ein Format namens . Die Punktnotation ermöglicht es Ihnen, auf Werte innerhalb eines Objekts zuzugreifen. Die Punktnotation ist nützlich, um aus einem großen JSON-Antworttext nur das herauszufiltern, was Sie benötigen, und bietet Ihnen mehr Flexibilität bei der Formatierung von HTTP-Konnektor-Funktionen. Einfach ausgedrückt: Es handelt sich um ein strukturiertes Format, das auf ineinander verschachtelten Werten basiert.
Lassen Sie uns anhand eines Beispiels erläutern, wie die Punktnotation in Konnektorausgaben verwendet wird.
Das folgende Beispielobjekt namens „employees“ enthält ein Array von Objekten mit Details zu jedem Mitarbeiter. Wenn wir nur auf die Berufsbezeichnung jedes Mitarbeiters zugreifen möchten, würden wir die Syntax „employees.title“ verwenden. Wir nutzen einen Punkt, um auf die Werte zuzugreifen, die den Schlüsseln zugeordnet sind, die uns interessieren. Nehmen wir an, wir wollten nur das erste Ergebnis abrufen. Dies würden wir festlegen, indem wir die Indexposition zwischen dem Namen des Hauptobjekts „employees“ und dem Wert, der uns interessiert, „title“, einfügen. Die Syntax würde wie folgt aussehen: employees.0.title. Bei komplexeren Objekten müssen Sie möglicherweise tiefer in das Objekt vordringen, um die gewünschten Informationen abzurufen.
Gehen wir mit einem weiteren Beispiel noch einen Schritt weiter. Nehmen wir in diesem Fall an, wir möchten eine Connector-Funktion erstellen, um Informationen abzurufen, die mit Artikeln in der Wissensdatenbank verknüpft sind. Unser Connector gibt das folgende JSON-Objekt mit dem Namen „data“ zurück, das Daten zu einem bestimmten Artikel enthält:
Wenn wir beispielsweise nur die ID, den Titel, die Version und die Angabe, ob der Artikel ausgeblendet ist oder nicht, abrufen wollten, müssten wir dies mithilfe von „Outputs“ festlegen. Sehen wir uns an, wie die Punktnotation im „Outputs“-Bereich des Editors aussieht:
Um Ergebnisse wie „id“ und „title“ abzurufen, müssen wir angeben, wo sich diese Ergebnisse innerhalb des JSON-Objekts befinden. Der Hauptteil der Ausgabe ist „data“, was dem ersten Dropdown-Menü im Abschnitt „Testergebnisse“ entspricht. Jedes Ergebnis innerhalb des Dropdown-Menüs „data“ ist in diesem Objekt verschachtelt. Im Abschnitt „Outputs“ bedeutet ein Punkt, dass man eine Ebene tiefer in das „data“-Objekt vordringt.
It doesn’t matter whether the dot is placed in the body, or in front of individual properties, so long as there is a dot separating each layer of the JSON.
Wenn wir im Abschnitt „Testergebnisse“ auf die Registerkarte „Ausgaben“ klicken, filtern wir die übrigen Daten heraus, sodass wir nur die Informationen sehen, die für uns von Interesse sind.
Eine weitere Möglichkeit, Ihre Ausgaben zu schreiben, ist die einzeilige Darstellung. Dabei wird der vollständige Pfad in einer einzigen Abfrage angezeigt.
Als praktischer Trick zum Schreiben des Ausgabepfads können Sie auch auf eine Datenzeile klicken, um diese als neue Ausgabe hinzuzufügen.
Weitere Informationen zur Verwendung der Punktnotation finden Sie in dieser Ressource: Processmaker: JSON-Punktnotation.
Ausgabeergebnisse
Es gibt mehrere Möglichkeiten, Ausgänge zu strukturieren, aber wie Sie dabei vorgehen, hängt ganz davon ab, was Sie mit den Daten in Ihren Anwendungen erreichen möchten. Bevor Sie mit der Strukturierung der Ausgänge beginnen, sollten Sie sich über Ihr Endziel Gedanken machen. Möchten Sie mehrere Datentypen in einzelnen Variablen anzeigen? Oder haben Sie dieselben Datentypen in einem Array, das Sie einfach nach relevanten Informationen durchsuchen möchten?
Die folgenden Beispiele basieren alle auf derselben Connector-Funktion, und in jedem Fall ist der Hauptteil der Testergebnisse identisch. Die Ausgaben variieren jedoch je nach ihrer Strukturierung.
Das folgende Beispiel zeigt, wie der Konnektor die Daten für den JSON-Pfad „data.hits.slug“ ausgibt. Aufgrund der Struktur dieser Ausgabe gibt der Konnektor ein großes Array mit allen URL-Slugs für Knowledge-Base-Artikel zurück. In unseren Anwendungen ist auf diese Rückgabe des Konnektors über eine Array-Variable zugegriffen werden können.
Wir können die Ausgaben als Liste von Objekten strukturieren und einzelne Datentypen aus den Ergebnissen extrahieren, wodurch mehrere Datenobjekte entstehen, die in Anwendungen einzeln angezeigt werden können.
Objektlisten sind Objekte, die mehrere verschachtelte Datentypen enthalten. Verwenden Sie Objektlisten, indem Sie auf den Ausgabetyp klicken und den Schalter „Liste“ in der rechten Ecke umlegen.
Wenn Sie über eine Liste von Objekten verfügen, können Sie verschiedene Datentypen ganz einfach als einzelne Datenelemente in Ihren Anwendungen verwenden.
Kehren wir zu einem der obigen Beispiele zurück und machen wir unseren Ausgabepfad „data.hits.slug“ zu einer Liste. In den folgenden Ergebnissen sehen Sie, dass Tulip die Rückgabe dieses Konnektors als Array von Slugs strukturiert, wobei jede Indexposition neben dem jeweiligen Wert aufgeführt ist.
Mit diesem Verständnis der Ausgabedaten im Hinterkopf können Sie nun die Ausgabedaten Ihren eigenen Konnektorfunktionen zuordnen und die von Ihren Konnektoren zurückgegebenen Ergebnisse optimieren!
Verwenden Sie Tulip AI zur Extraktion von Ausgabedaten
Strukturieren Sie Ihre Ausgabedaten schnell, indem Sie die bereits in diesem Artikel behandelten Beispiele und Konzepte nutzen, wie z. B. ( und Liste von Objekten).
Tulip AI bietet eine leistungsstarke Abkürzung, um die JSON-Antwort in Ihren Testergebnissen automatisch zu analysieren und die entsprechenden Dot-Notation-Pfade zu generieren. Es versucht, die verschachtelte Objektstruktur nachzubilden, glättet jedoch bei Bedarf komplexe Arrays oder Objekte.
Tulip AI verändert Ihre bestehenden Ausgaben und Extraktionen nicht. Es generiert lediglich neue oder noch nicht festgelegte Ausgaben, um den anfänglichen Konfigurationsprozess der Ausgaben zu beschleunigen.
Sobald Tulip AI die Ausgabedaten generiert hat, müssen Sie diese im Hinblick auf das Ziel Ihrer Anwendung überprüfen.
Beachten Sie bei der Überprüfung die folgenden Best Practices:* Entfernen Sie alle nicht benötigten Ausgabedaten* Benennen Sie die Variablen zur besseren Übersichtlichkeit um* Passen Sie die Ausgabestruktur manuell an (z. B. indem Sie sicherstellen, dass Arrays korrekt als „Lists of Objects“ festgelegt sind)
Diese Schritte stellen sicher, dass Sie nur die für Ihre Anwendung erforderlichen Daten extrahieren.
Weiterführende Informationen
- Verwendung von HTTP-Konnektoren in Apps
- Anzeigen interaktiver Listen mit Tabelleneinträgen oder Konnektorausgaben in Apps
{{snippet.Haben Sie gefunden, wonach Sie gesucht haben?}}