Skip to Content
DocsStudioStudio Extensions

Studio Extensions

Mit Studio Extensions kann der Funktionsumfang des ProcessCube® Studios erweitert und an individuelle Bedürfnisse angepasst werden. Die ProcessCube Platform bietet bereits einige Extensions, die optional zum Studio hinzugefügt werden können.

Was sind Studio Extensions?

Studio Extensions sind Plugins, die zusätzliche Funktionen zum Studio hinzufügen und es ermöglichen, das Studio umfassend zu individualisieren. Extensions können neue Features bereitstellen, bestehende Funktionen erweitern oder die Benutzeroberfläche anpassen.

Vorteile von Extensions

  • Individualisierung: Passen Sie das Studio an Ihre spezifischen Anforderungen an
  • Produktivität: Erweitern Sie das Studio um zeitsparende Funktionen
  • Integration: Integrieren Sie externe Tools und Services
  • Wiederverwendbarkeit: Teilen Sie Extensions mit Ihrem Team
  • Flexibilität: Aktivieren oder deaktivieren Sie Extensions nach Bedarf

Verfügbare Extensions

Die ProcessCube Platform stellt folgende offizielle Extensions bereit:

Error Handling Extension

Ermöglicht die Auswahl und das Zuordnen eines Prozesses, der im Fehlerfall ausgeführt werden soll.

Hauptfunktionen:

  • Fehler-Prozesse definieren
  • Automatische Fehlerbehandlung konfigurieren
  • Fallback-Strategien implementieren
  • Error Recovery Flows erstellen

Diese Extension ist besonders nützlich für produktive Umgebungen, in denen robuste Fehlerbehandlung erforderlich ist.

Git Plugin (Azure)

Enthält eine benutzerfreundliche Oberfläche für das Versionieren von BPMN-Workflows mit Git und Azure Repos.

Hauptfunktionen:

  • BPMN-Diagramme in Azure Repos versionieren
  • Commit-Historie einsehen
  • Branches verwalten
  • Pull/Push-Operationen durchführen
  • Merge-Konflikte lösen

Diese Extension ermöglicht professionelles Versions-Management direkt im Studio.

Custom Service Tasks Extension

Erleichtert die Eingabe von Parametern für spezielle Engine-Extensions und Service-Tasks.

Retry Process

Nach der Auswahl des Typs Retry Process werden zusätzliche Felder für den Neustart eines fehlerhaften Prozesses angezeigt:

  • processInstanceIdToRetry - ID der fehlerhaften Prozess-Instanz
  • flowNodeIdToRetry (optional) - ID des Flow-Nodes, bei dem fortgesetzt werden soll
  • flowNodeInstanceIdToRetry (optional) - ID der Flow-Node-Instanz
  • newToken - Neues Token für den Neustart

Diese Funktion ist Teil der error_handling Engine-Extension.

Mail Service

Nach der Auswahl des Typs Mail Service werden zusätzliche Felder für den E-Mail-Versand angezeigt:

  • recipient - E-Mail-Empfänger
  • recipientCc (optional) - CC-Empfänger
  • subject - E-Mail-Betreff
  • mailtext - E-Mail-Inhalt

Diese Funktion ist Teil der mail_service Engine-Extension.

Snippets Plugin

Ermöglicht das Speichern, Verwalten und Laden von BPMN-Teilen über die Zwischenablage.

Hauptfunktionen:

  • BPMN-Teile als Snippets speichern
  • Snippet-Bibliothek verwalten
  • Snippets in Diagramme einfügen
  • Snippets mit dem Team teilen

Diese Extension ist ideal für die Wiederverwendung häufig verwendeter BPMN-Patterns.

Extensions installieren

Die Installation von Extensions erfolgt über das Extension-Management im Studio. Detaillierte Installationsanleitungen werden mit jeder Extension bereitgestellt.

Installation über das Studio

  1. Öffnen Sie das Extensions-Panel im Studio
  2. Suchen Sie die gewünschte Extension
  3. Klicken Sie auf Install
  4. Starten Sie das Studio neu, falls erforderlich

Manuelle Installation

Extensions können auch manuell installiert werden:

  1. Laden Sie die Extension-Datei herunter
  2. Platzieren Sie sie im Extensions-Verzeichnis des Studios
  3. Starten Sie das Studio neu
  4. Aktivieren Sie die Extension in den Einstellungen

Extensions konfigurieren

Jede Extension kann über die Studio-Einstellungen konfiguriert werden.

Einstellungen öffnen

Öffnen Sie die User Settings über View → User Settings.

Extension-Einstellungen

Die Einstellungen für Extensions finden Sie unter dem entsprechenden Extension-Namen. Jede Extension kann individuelle Konfigurationsoptionen haben.

Beispiel-Konfiguration:

"extensions": { "errorHandling": { "enabled": true, "defaultErrorProcess": "error-handler" }, "gitPlugin": { "enabled": true, "remoteUrl": "https://dev.azure.com/..." } }

Custom Themes

Neben funktionalen Extensions unterstützt das Studio auch Custom Themes, mit denen die visuelle Erscheinung angepasst werden kann.

Theme-Extension erstellen

Custom Themes können als Extensions bereitgestellt werden:

  1. Definieren Sie ein Theme-Schema (Farben, Fonts, etc.)
  2. Registrieren Sie das Theme als Extension
  3. Installieren Sie die Theme-Extension im Studio
  4. Aktivieren Sie das Theme in den Einstellungen

Verwendung von Themes

Themes können verwendet werden, um:

  • Verschiedene Umgebungen visuell zu unterscheiden (z.B. rote Farbe für Produktiv-Engine)
  • Corporate Design umzusetzen
  • Persönliche Präferenzen einzustellen
  • Barrierefreiheit zu verbessern

Service-Task-Templates

Service-Task-Templates sind vordefinierte Konfigurationen für häufig verwendete Service-Tasks.

Verfügbare Templates

Das Studio kann mit verschiedenen Service-Task-Templates ausgeliefert werden:

  • HTTP-Requests: Vorkonfigurierte Templates für REST-API-Aufrufe
  • E-Mail-Versand: Templates für E-Mail-Benachrichtigungen
  • Datenbankzugriff: Templates für Datenbankoperationen
  • Dateitransformationen: Templates für Dateiverarbeitung

Eigene Templates erstellen

Sie können eigene Service-Task-Templates erstellen:

  1. Definieren Sie die Task-Konfiguration
  2. Speichern Sie sie als Template
  3. Verwenden Sie das Template in Ihren Prozessen
  4. Teilen Sie Templates mit Ihrem Team

Extension-Entwicklung

Sie können eigene Extensions für das Studio entwickeln.

Voraussetzungen

Für die Extension-Entwicklung benötigen Sie:

  • Kenntnisse in TypeScript/JavaScript
  • Verständnis der Studio-Architektur
  • Zugriff auf die Extension-API
  • Entwicklungsumgebung (IDE, Git, npm)

Extension-API

Das Studio stellt eine Extension-API bereit, die folgende Möglichkeiten bietet:

  • UI-Extensions: Hinzufügen von Panels, Menüs und Dialogen
  • BPMN-Extensions: Erweitern der BPMN-Modellierung
  • Engine-Extensions: Integration mit Engine-Features
  • Event-Handling: Reagieren auf Studio- und Prozess-Events

Die vollständige Extension-API-Dokumentation wird in einer zukünftigen Version bereitgestellt.

Best Practices

Extension-Nutzung

  • Selektiv installieren: Installieren Sie nur Extensions, die Sie tatsächlich benötigen
  • Aktuell halten: Halten Sie Extensions auf dem neuesten Stand
  • Testen: Testen Sie Extensions in einer Entwicklungsumgebung
  • Dokumentieren: Dokumentieren Sie verwendete Extensions und deren Konfiguration

Extension-Entwicklung

  • Modular: Entwickeln Sie kleine, fokussierte Extensions
  • Dokumentation: Stellen Sie umfassende Dokumentation bereit
  • Versionierung: Nutzen Sie Semantic Versioning
  • Abhängigkeiten: Minimieren Sie externe Abhängigkeiten
  • Testing: Implementieren Sie automatisierte Tests

Troubleshooting

Extension lädt nicht

Problem: Eine installierte Extension wird nicht geladen.

Lösungen:

  • Prüfen Sie, ob die Extension aktiviert ist
  • Überprüfen Sie die Extension-Konfiguration
  • Starten Sie das Studio neu
  • Prüfen Sie die Studio-Logs auf Fehler

Extension verursacht Fehler

Problem: Das Studio verhält sich nach der Extension-Installation fehlerhaft.

Lösungen:

  • Deaktivieren Sie die Extension
  • Überprüfen Sie die Kompatibilität mit Ihrer Studio-Version
  • Aktualisieren Sie die Extension auf die neueste Version
  • Kontaktieren Sie den Extension-Entwickler

Extension-Einstellungen werden nicht übernommen

Problem: Geänderte Extension-Einstellungen haben keine Wirkung.

Lösungen:

  • Starten Sie das Studio nach Änderungen neu
  • Prüfen Sie die JSON-Syntax der Einstellungen
  • Überprüfen Sie, ob die Einstellungen an der richtigen Stelle sind

Extension-Verwaltung

Extensions auflisten

Alle installierten Extensions können über das Extensions-Panel eingesehen werden:

  1. Öffnen Sie das Extensions-Panel
  2. Sehen Sie die Liste aller installierten Extensions
  3. Überprüfen Sie Status und Version jeder Extension

Extension aktivieren/deaktivieren

Extensions können temporär deaktiviert werden, ohne sie zu deinstallieren:

  1. Öffnen Sie das Extensions-Panel
  2. Finden Sie die gewünschte Extension
  3. Klicken Sie auf Enable oder Disable
  4. Starten Sie das Studio neu

Extension deinstallieren

So entfernen Sie eine Extension:

  1. Öffnen Sie das Extensions-Panel
  2. Finden Sie die Extension
  3. Klicken Sie auf Uninstall
  4. Bestätigen Sie die Deinstallation
  5. Starten Sie das Studio neu

Weitere Informationen