LowCode Integration

Über Cuby wird eine lokale Low-Code-Plattform bereitgestellt, die auf Node-RED basiert und Dashboard-2 für die UI-Entwicklung bietet.

Überblick

Die lokale Low-Code-Plattform (über Cuby) ermöglicht es, Flows, Dashboards und APIs zu erstellen und zu testen. Sie ist optimal für die schnelle Entwicklung von Automatisierungen und Benutzeroberflächen geeignet.

Zugriff auf die Plattform

• URL: http://localhost:1880
• Dashboard: http://localhost:1880/dashboard
• API Dokumentation: http://localhost:1880/api-docs
• Verwendung: Low-Code Flows und Dashboard-Entwicklung

Die Plattform kann über eine entsprechende Schaltfläche in der Activity Bar des Studios angesteuert werden.

Komponenten der Low-Code-Plattform

Die lokale Low-Code-Plattform umfasst drei Hauptkomponenten:

Node-RED Editor

Der Editor ermöglicht das Erstellen, Bearbeiten und Verwalten von Flows.

Hauptfunktionen:

• Flow-Entwicklung: Visuelle Programmierung mit Drag & Drop
• Node-Bibliothek: Umfangreiche Sammlung vorgefertigter Nodes
• Engine-Integration: Direkte Anbindung an die Engine
• Debugging: Echtzeit-Debugging und Monitoring von Flows

Mit dem Studio werden bereits vorgefertigte Flows ausgeliefert, die das Portal im Dashboard sowie die Portal-API zur Kommunikation mit der Engine bereitstellen.

Dashboard-2

Das Dashboard ermöglicht das Erstellen von Benutzeroberflächen für die Flows.

Hauptfunktionen:

• UI-Komponenten: Moderne Dashboard-2 Widgets
• Prozess-Portal: Vorgefertigtes Portal zum Starten von Prozessen
• User-Task-Verwaltung: Bearbeitung von User-Tasks direkt im Browser
• Responsive Design: Automatische Anpassung an verschiedene Bildschirmgrößen

Der vom Studio ausgelieferte Portal-Flow ermöglicht das Starten von Prozessen und das Bearbeiten von User-Tasks über eine intuitive Web-Oberfläche.

API Dokumentation

Die API-Dokumentation stellt eine interaktive Swagger-Oberfläche bereit.

Hauptfunktionen:

• API-Übersicht: Alle verfügbaren Endpunkte im Überblick
• Interaktives Testing: Endpunkte direkt aus der Dokumentation testen
• Schema-Dokumentation: Detaillierte Beschreibung aller Datenstrukturen
• Authentifizierung: Test mit verschiedenen Authentifizierungsmethoden

Zugriff auf die Low-Code-Plattform

Vorgefertigte Flows

Das Studio wird mit mehreren vorgefertigten Flows ausgeliefert:

Portal Flow

Der Portal Flow stellt eine vollständige Prozess-Portal-Anwendung bereit:

• Prozesse starten: Übersicht aller verfügbaren Prozesse mit Start-Funktion
• User-Tasks bearbeiten: Liste aller offenen User-Tasks mit Bearbeitungs-Formular
• Prozess-Überwachung: Status laufender Prozess-Instanzen
• Authentifizierung: Integration mit der lokalen Authority

API Flow

Der API Flow stellt REST-Endpunkte für die Kommunikation mit der Engine bereit:

• Prozess-Management: Endpoints zum Starten und Stoppen von Prozessen
• User-Task-API: Verwaltung von User-Tasks über REST
• Prozess-Daten: Zugriff auf Prozess-Variablen und -Status
• Ereignisse: WebHooks für Prozess-Ereignisse

Node-RED Editor verwenden

Flow erstellen

Engine-Integration

Die Low-Code-Plattform ist vollständig in die Engine integriert:

• ProcessCube Nodes: Spezialisierte Nodes für Engine-Operationen
• Prozess-Events: Empfang von Ereignissen aus der Engine
• User-Task-Handling: Automatische Verarbeitung von User-Tasks
• Prozess-Variablen: Zugriff auf und Manipulation von Prozessdaten

Dashboard-2 verwenden

Dashboard-Seite erstellen

Verfügbare Widgets

Dashboard-2 bietet eine Vielzahl von Widgets:

• Buttons: Schaltflächen für Benutzeraktionen
• Forms: Formulare für Dateneingabe
• Tables: Tabellarische Darstellung von Daten
• Charts: Visualisierung von Daten
• Gauges: Anzeige von Messwerten
• Templates: Benutzerdefinierte HTML/CSS/JS-Komponenten

Paket-Installation

Manuelle Paket-Installation

Für die Installation zusätzlicher Node-RED-Pakete im Studio:

1. Identifizieren Sie das gewünschte Paket auf flows.nodered.org 
2. Kontaktieren Sie den Support für Unterstützung bei der Installation
3. Alternativ: Verwenden Sie eine externe Node-RED-Instanz ohne diese Einschränkung

Weitere Informationen finden Sie in der LowCode-Dokumentation.

Konfiguration der lokalen Low-Code-Plattform

Die lokale Low-Code-Plattform wird über Cuby verwaltet und konfiguriert.

Konfiguration über User Settings

Die User Settings finden Sie unter View → User Settings im Studio-Menü.

Beispiel-Konfiguration:

"launchScripts.extraScripts": [
  {
    "id": "__internal_studio_lowcode__",
    "port": 1880,
    "name": "Studio LowCode",
    "enabled": true
  }
]

Verfügbare Optionen

Praktische Anwendungsfälle

Prozess-Portal erstellen

Erstellen Sie ein benutzerfreundliches Portal für Ihre Prozesse:

1. Verwenden Sie die vorgefertigten Portal-Flows als Basis
2. Passen Sie das Dashboard an Ihre Anforderungen an
3. Erweitern Sie die Funktionalität mit zusätzlichen Nodes
4. Deployen Sie das Portal für Ihre Benutzer

Automatisierungen entwickeln

Entwickeln Sie Automatisierungen ohne Code:

1. Erstellen Sie Flows für wiederkehrende Aufgaben
2. Integrieren Sie externe Systeme über HTTP/MQTT/etc.
3. Nutzen Sie die Engine-Integration für Prozess-Interaktionen
4. Überwachen Sie die Ausführung über das Dashboard

APIs bereitstellen

Stellen Sie REST-APIs für Ihre Anwendungen bereit:

1. Definieren Sie HTTP-Endpunkte in Node-RED
2. Implementieren Sie die Business-Logik mit Flows
3. Dokumentieren Sie die API in Swagger
4. Testen Sie die Endpunkte über die API-Dokumentation

Best Practices

Flow-Entwicklung

• Modularität: Teilen Sie komplexe Flows in kleinere, wiederverwendbare Subflows auf
• Kommentare: Dokumentieren Sie Ihre Flows mit Kommentar-Nodes
• Fehlerbehandlung: Implementieren Sie Catch-Nodes für robuste Error-Handling
• Testing: Testen Sie Flows mit Debug-Nodes und dem Debug-Panel

Dashboard-Design

• Responsiveness: Testen Sie Ihr Dashboard auf verschiedenen Bildschirmgrößen
• Benutzerfreundlichkeit: Halten Sie die Oberfläche intuitiv und übersichtlich
• Performance: Vermeiden Sie zu viele Widgets auf einer Seite
• Feedback: Geben Sie Benutzern visuelles Feedback bei Aktionen

Sicherheit

• Authentifizierung: Nutzen Sie die Authority-Integration für sichere Zugriffe
• Validierung: Validieren Sie alle Benutzereingaben
• Berechtigungen: Implementieren Sie rollenbasierte Zugriffskontrolle
• Secrets: Speichern Sie keine sensiblen Daten in Flows

Troubleshooting

Low-Code-Plattform startet nicht

Problem: Die Plattform startet nicht beim Studio-Start.

Lösungen:

• Prüfen Sie, ob der Port 1880 bereits belegt ist
• Überprüfen Sie die Launch Script Settings
• Starten Sie das Studio neu

Dashboard lädt nicht

Problem: Das Dashboard unter http://localhost:1880/dashboard zeigt Fehler.

Lösungen:

• Stellen Sie sicher, dass Dashboard-2 Nodes im Flow vorhanden sind
• Deployen Sie die Flows neu
• Überprüfen Sie die Browser-Konsole auf Fehler

Engine-Connection fehlgeschlagen

Problem: Node-RED kann keine Verbindung zur Engine herstellen.

Lösungen:

• Prüfen Sie, ob die Engine läuft
• Überprüfen Sie die Engine-URL in den ProcessCube Nodes
• Stellen Sie sicher, dass Sie authentifiziert sind

Externe Low-Code-Instanz verwenden

Anstelle der lokalen Low-Code-Plattform können Sie auch eine externe Instanz verwenden:

Weitere Informationen finden Sie in der LowCode-Dokumentation.

Weitere Informationen

• LowCode Dokumentation - Vollständige Low-Code-Dokumentation
• Node-RED Dokumentation  - Offizielle Node-RED Docs
• Dashboard-2 Dokumentation  - Dashboard-2 Guide
• Getting Started - Erste Schritte mit dem Studio