Die Anbindung von Redash an die ERPNext API

1. Wichtige Informationen

In diesem Beitrag können Sie nachlesen, wie Redash, ein Monitoring Tool, an die ERPNext API angebunden werden kann.

Hierbei wird sich zwar explizit auf die Anbindung an Redash bezogen, allerdings sollten sich die vorgestellten Methoden relativ ähnlich auch auf andere Monitoring Tools, wie beispielsweise Grafana, anwenden lassen.

Es lässt sich zu den vorgestellten Methoden dieses Beitrages ergänzen, dass diese verwendet werden können um nahezu jede API an Redash anzubinden (Voraussetzung hierfür ist, dass JSON als Ergebnis einer Abfrage zurückgibt).

Sollten Sie Interesse haben eine JSON Quelle mit Redash zu visualisieren, kann sich dieser Blogbeitrag ebenfalls für Sie lohnen!

Möchten Sie die Datenbank von ERPNext direkt an Redash anzubinden, bitten wie Sie unseren anderen Blogbeitrag (LINK) zu besuchen.

2. Die Anbindung

2.1. Voraussetzungen

Um die ERPNext API via Redash zu nutzen, müssen zwei Voraussetzungen erfüllt werden, bevor sich Queries erstellen lassen können. In diesem Kapitel werden diese beiden Voraussetzungen vorgestellt.

Voraussetzung 1: 

Einen ERPNext Benutzer / User der die nötigen Leseberechtigungen für die Daten besitzt, die man Abfragen möchte.

Es ist von Vorteil einen API User anzulegen und diesem die notwendigen Leseberechtigungen zu geben. Der Administrator Account funktioniert selbstverständlich auch, ist allerdings nicht zu empfehlen, da dieser zu viele Rechte für reine Leseaufgaben besitzt und auch für Methodenaufrufe über die API misshandelt werden kann.

Vertriebstrichter

Voraussetzung 2: 

Ein neu angelegte Redash Data Source. 

Diese kann man unter “Settings“ – „Data Sources“ – „New Data Source“ anlegen.

Unter der Auswahl welche Daten Ressource nun angeschlossen wird, wählt man nun „JSON“ aus, da die ERPNext-API Objekte immer im JSON Format zurückgibt.

Vertriebstrichter

Im nächsten Schritt gibt man der Daten Ressource einen Namen und setzt die Anmeldedaten des gewünschten ERPNext Benutzers ein, in unserem Fall (gute Tugend) der API Account.

Vertriebstrichter

Nun sind die Vorbereitungen für die eigentlichen Abfragen abgeschlossen und es kann gezeigt werden wie neue Queries in Redash mit der API als Data Source erstellt werden können.

2.2 Erstellung von Queries mit der API als Quelle

Um die API erfolgreich am besten für sich nutzen zu können, empfiehlt es sich, zumindestens in Redash, zwei Queries zu erstellen.

2.2.1 Syntax einer ERPNext Abfrage & Dokumentation

Syntax: https://ERPNEXTURL.de/api/resource/DOCTYPE ?OPTIONALE_FILTER

Dokumentation: https://frappeframework.com/docs/user/en/guides/integration/rest_api

Wir persönlich empfehlen Ihnen den Filter “limit_page_length=HIER_ANZAHL” mit anzugeben. Der Grund hierfür ist, dass die Standard ERPNext Api ohne Angabe dieses Filters, die zurückgegebene Anzahl von Objekten auf 20 reduziert.

Erste Query

Die erste Query ist die eigentliche API Abfrage und wird verwendet um die Daten von der ERPNext API abzufragen und somit in Redash vorliegen zu haben. Eine API Abfrage mit anschließender JSON Antwort kann beispielsweise so ausschauen, wie in der nächsten Abbildung.

Vertriebstrichter

Zweite Query

In der ersten Query wurde festgestellt, dass aus den JSON Ergebnissen keine Visualisierungen erstellt werden können. Hierfür ist nun die zweite Redash Query verantwortlich.

Die zweite Query funktioniert nun wie gewohnt in SQL Syntax. (Siehe nächste Abbildung)

Vertriebstrichter

Wo finde ich heraus Welche Query die richtige für „Query Nummer zwei“ ist?

Hierfür einfach in die “JSON Query” rein gehen und in der URL schauen! (Rot unterstrichen)

Vertriebstrichter

3. Fazit

Ziel dieses Blog Beitrages war es unser Wissen weiterzugeben und zu zeigen wie Redash an die ERPNext API angebunden werden kann. Hierfür wurden erstmals Voraussetzungen vorgestellt, welche die Basis für die im Anschluss die notwendigen Queries darstellen werden. Im Hauptteil dieses Blog Beitrages wurden Syntax von ERPNext API Anfragen, sowie die Erstellung von Query eins & zwei behandelt.

Somit wären in diesem die wichtigsten Aspekte einer Anbindung von Redash an die ERPNext API beschrieben worden. In unserem nächsten Blogbeitrag stellen wir eine andere Methode vor wie Redash an ERPNext angebunden werden kann, nämlich über die direkte Anbindung der Datenbank.

Haben Sie sonstige Fragen oder Interesse an Redash oder ERPNext? Dann zögern Sie nicht und kontaktieren Sie unser Team von K&K Software. Wir unterstützen Sie gerne in Ihren Vorhaben!

Screenshotupdate

Alle Screenshots in diesem Blogpost sind auf Version 13 von ERPNext aktualisiert.

Letzter Stand der Aktualisierung: 02.09.2021

Autor Laura Köpl

Über den Autor

Laura Köpl ist unsere Projektleiterin ERPNext und unterstützt in Kundenprojekten als ERP-Prozess-Consultant. Außerdem verantwortet Sie den Vertrieb der K&K Software AG.
Privat hat sie - wenn sie nicht gerade auf dem Motorrad sitzt - als Vorsitzende des Hackerspace GEOLab e.V. eine Begeisterung für den kreativen Umgang mit Technik und freut sich auf den nächsten Chaos Communication Congress.

Laura Köpl ist Ihre Ansprechpartnerin für ERPNext-Projekte und Sie erreichen Sie unter 09382-3102-241 oder koepl@kk-software.de um die Details Ihres ERPNext-Projektes zu besprechen.

12. November 2021

Jobs bei K&K Software

Unter https://stellen.kk-software.de finden Sie eine Übersicht unserer aktuellen Stellenangebote.