@5minds/processcube_engine

5Minds Engine

Die 5Minds Engine ist eine Stand-alone Anwendung, die für das Ausführen der mit dem Studio modellierten Prozesse zuständig ist.

Sie kann entweder als globals NPM Paket, oder als Docker Container verwendet werden.

Ausführliche Anwendungsbeispiele finden sich in den Code Docs.

Voraussetzungen

• Minimal benötigte NodeJS Version: >= v16.13.x
• Empfohlene NodeJS Version: >= v18.15.x
• Auf Windows Systemen: Die Windows Build Tools
• Eine laufende Authority
  • Die Engine verwendet diese Authority zur Benutzerauthentifizierung
• Derzeit unterstützte DBMS sind:
  • MS SQL Server
  • PostgreSQL
  • SQLite

Falls PostgreSQL oder MS SQL Server als Datenbank verwendet werden, muss eine entsprechende Instanz erreichbar sein.

Schnellstart mit NPM

Installation:

npm install -g @5minds/processcube_engine

Starten:

processcube-engine

Die Engine ist nun unter http://localhost:10560 erreichbar.

Über den Browser ist auf diesem Wege eine vollumfängliche Dokumentation der Engine API verfügbar.

Hinweis: Falls der Befehl processcube-engine unter Windows nicht funktioniert, bitte sicherstellen, dass PATH korrekt gesetzt wurde. Auch muss die Command Shell mit Administratorrechten gestartet werden.

Schnellstart mit Docker

Ein Docker Image ist auf Dockerhub verfügbar.

Zum schnellen Starten eines Containers kann folgender Befehl genutzt werden:

docker run -p 10560:10560 5minds/processcube_engine

Sollte das Image noch nicht lokal vorhanden sein, wird es vorher heruntergeladen.

Weitere Infos zur Verwendung mit Docker:

• Installationsanleitung
• Erste Schritte

Konfiguration

Standardmäßig nutzt die Engine die interne SQLite Konfiguration.

Eine eigene Konfigurationsdatei kann mit der Umgebungsvariable CONFIG_PATH gesetzt werden.

Beispiel:

CONFIG_PATH=/<path_to_configfile>/<filename>.json processcube-engine

Eine ausführliche Anleitung findet sich in unserer Konfigurationsanleitung.

Auch ist ein Set an Beispielkonfigurationen verfügbar.

Arbeitsverzeichnis

Die Engine speichert ihre lokalen Dateien in folgendem Verzeichnis:

Platform	Folder Path
macOS	/Users/<Username>/.atlas/engine
Linux	/home/<Username>/.atlas/engine
Windows	c:\Users\<Username>\.atlas\engine

Die per Default verwendete SQLite Datenbank befindet sich an diesem Ort.

Ansprechpartner

• Christian Werner
• Sebastian Griesa