Zum Hauptinhalt springen

Aufrufen eines Drittanbieter REST-API mit Nooxl Apps

Um Automatisierungsprozesse außerhalb der Nooxl Apps zu starten können Sie von einem Nooxl Modell ein externes REST-API aufrufen und Daten aus Nooxl Apps übergeben. Zuerst wird eine Daten-Verbindung vom Typ "REST-API" in der Nooxl Datenintegration sowie eine Datenabfrage mit Parametern angelegt. Diese kann anschließend in einem Nooxl Modell in einer Datenabfrage-Sektion verwendet werden.

Anlegen einer Datenintegration in Nooxl Apps​

Die Datenintegration finden Sie unter dem entsprechenden App-Tab.

Datenintegration

  • (1) Datenintegration anlegen
  • (2) Datenintegration bearbeiten
  • (3) Datenabfrage-Befehl
  • (4) Datenabfrage-Parameter

(1) Datenintegration anlegen​

Sofern Sie eine ausreichende Berechtigung und die Lizenz besitzen, können Sie hier die URL und Parameter des Drittanbieters für den Aufruf hinterlegen.

(2) Datenintegration REST_API mit URL​

Datenintegration

  • [A] Hier muss der Verbindungstyp REST_API ausgewählt sein.
  • [B] Als Verbindungszeichenfolge wird ein JSON-String mit headers und url eingetragen. Es können Parameter verwendet werden: {{parameter name}}. Die Parameter müssen im Schritt (4) angelegt werden.

(3) Datenabfrage-Befehl mit Body​

Datenabfrage-Befehl

  • [A] Hier wird NO_RESULT ausgewählt.
  • [B] Als Befehltstext wird ein JSON-String mit method und body eingetragen. Aktuell kann nur die Methode post verwendet werden. Es können Parameter verwendet werden: {{parameter name}}. Die Parameter müssen im Schritt (4) angelegt werden.

(4) Datenabfrage-Parameterdefinition​

Datenabfrage-Parameter

  • [A] Der Name des Parameters in Klammern {{parameter name}} wird verwendet um diesen im Befehltstext des Datenabfrage-Befehl sowie in der Verbindungszeichenfolge des Datenverbindung mit Werten aus einem Nooxl Modell bzw. den Standard-Werten beim Ausführen zu ersetzen.
  • [B] Neben den klassischen Datentypen übergibt ein CellRange ein String-Array der Zeilen mit den String-Arrays der Spalten: [["R1C1-Value"], ["R1C2-Value"] ], [["R2C1-Value"], ["R2C2-Value"] ] für ein 2 Rows x 2 Columns Array.
  • [C] Falls der Parameter in der Nooxl Modell-Sektion nicht zugewiesen wird, dann wird statt dessen der Standard-Werte eingefügt.
  • [D] Folgende Optionen sind für Parameter mögliche:
    • Option Optional: Der Parameter muss in der Nooxl Modell-Sektion nicht zugewiesen werden.
    • Option Nicht Änderbar: Der Parameter kann in der Nooxl Modell-Sektion nicht zugewiesen werden. Es wird immer der Standard-Wert verwendet.
    • Option Nullwerte zulassen: Nullwerte werden nicht als Fehler interpretiert.

Verwendung der Datenintegration in einer Modell-Sektion​

Nach der Festlegung einer Datenverbindung mit einem Datenabfrage-Befehls kann dieser in einem Nooxl Modell verwendet werden.

Markierungen im Nooxl Modell​

Für unser Beispiel im Nooxl Modell "Akquisition Quick Check" werden Kennzahlen für einen Immobilien-Erwerb ermittelt. Die Kennzahlen und ein Status-Text sollen an ein Drittsystem übermittelt werden. Dazu werden 3 Markierungen benötigt: 2 Paramter-Bereiche und 1 Trigger-Bereich.

Markups der Sektion mit Modell im Entwurfsmodus
Markierungen der Datenabfrage-Sektion mit dem Nooxl Modell im Entwurfsmodus

  • (1) Die Markierung "KPIs" zeigt auf einen Zellbereich mit Ergebnis-Werte für den KPIs-Parameter.
  • (2) Die Markierung "Nächster Schritt" enthält Werte für den State-Parameter.
  • (3) Die Markierung "Start flow" zeigt auf die Zelle "Starten" zum Triggern des Aufrufes.

Einrichtung der Datenabfrage-Sektion im Nooxl Modell​

Sektion bearbeiten mit Modell im Entwurfsmodus

  • (1) Hier wird die Datenverbindung aus der Datenintgration gewählt.
  • (2) Hier wird ein zugehöriger Datenabfrage-Befehl mit seinen Parametern aus der Datenintgration gewählt.
  • (3) Den Paramterdefinitionen werden Markierungen zugeordnet, aus denen Werte für den Parameter aus dem Nooxl Modell ausgelesen werden.
  • (4) Bei Parametern des Datentypes CellRange können Optionen angebeben werden:
    • Option Text: Alle Werte werden als Text ausgelesen.
    • Option Kopfzeilen: Der Bereich enthält Kopfzeilen.
    • Option Typen: Der Datentyp der Werte wird über die erste Zeile automatisch bestimmt.
  • (5) Hier wird der Trigger für den Aufruf eingestellt. Der aufruf kann z.B. manuell beim Klick auf den Zellbereich oder auch autmatisch beim Speichern erfolgen.

Aufrufen des Drittanbieter-APIs​

Aufrufen des Drittanbieter-APIs

Zukünftig kann jetzt in unserem Beispiel-Modell nach Einstellung des "Nächsten Schrittes" (1) auf "Weitergabe GF" die Zelle "Starten" (2) angeklickt werden. Der API-Aufruf beim Drittanbieter erfolgt mit den KPI-Werten (3).