Projekt-Parameter
Wie kann ich Projekt-Parameter verwenden?
In einem bestehenden Projekt können Sie die Project Parameter Configuration, eine Datei mit der Endung *.param, mit projektspezifischen Parametern und Parameter-Gruppen anlegen.
Zudem können Sie dort Custom Types (Enums) mit Custom Type Values (Enum-Werten) deklarieren, die Sie später beim Erstellen eines Projekt-Parameters auswählen können. Ein möglicher Anwendungsfall von Custom Types mit Custom Type Values sind Bedingungen mit Condition-Bausteinen (siehe Bedingungen erstellen und verwenden).
Projekt-Parameter lassen sich anschließend wie globale und System-Parameter in den Werkzeugen des X4 Designers (Adapter Editor, Mapping Editor, Process Editor, Condition Editor, Properties View) nutzen und können mit dem Projekt exportiert bzw. importiert werden.
Projekt-Parameter und Projekt-Parameter-Gruppen werden beim Start des Servers geladen und mit dem jeweiligen Projekt deployed.
Sie können zur Laufzeit über ReST API, X4 Adapter oder Web Apps geändert und persistiert werden.
Vorteile von Projekt-Parametern
- Wiederverwendbarkeit von Komponenten durch Parametrierung wird erhöht.
- Der Prozess kann durch Projekt-Parameter direkt zur Laufzeit beeinflusst werden.
- Projekt-Parameter können mit der
*.param-Datei direkt mit dem Projekt exportiert oder importiert werden. - Projekt-Parameter können zur Laufzeit über das X4 Control Center (Swagger UI) oder über einen speziellen Adapter, den Adapter Project Parameter Management, geändert werden.
- Projektparameter können, genau wie System- und globale Parameter, in Mappings, Conditions und weiteren Konfigurationen, wie z.B. Adapter, sowie in Business Rules oder Human Tasks (BPM-Projekten) verwendet werden.
- Globale Parameter können in die Project Parameter Configuration kopiert werden, um dort projektspezifisch genutzt zu werden, siehe Globale Parameter in Projekt-Parameter kopieren.
Besonderheiten von Projekt-Parametern
- Scoping: Ein Parameterwert kann von allen Prozessen gemeinsam genutzt werden oder für jede Prozessausführung unterschiedlich sein.
- Kennwortverschlüsselung: Projekt-Parameter vom Typ Password werden über einen Laufzeitmechanismus verschlüsselt. Zur Entwicklungszeit sollten keine Kennwörter in der Datei konfiguriert werden.
- Parameter vom Typ Constant (read only): Ein Parameter kann als schreibgeschützt definiert werden, so dass er zur Laufzeit nicht geändert werden kann.
- Zugriffsbeschränkung: Sie können festlegen, dass ein Parameter nur von Benutzern mit einer bestimmten Rolle im Authentifizierungsprovider Keycloak bearbeitet werden kann (siehe https://www.keycloak.org im Bereich Docs> Server Administration).
- Metadaten: Metadaten (Beschreibung) liefern Informationen zum Parameter für die Konfiguration.
- X4 Control Center: Über das X4 Control Center (Swagger UI) können alle Parameter angezeigt werden, die der aktuell angemeldete Benutzer sehen oder bearbeiten darf.
Projekt-Parameter über den Project Parameter Management verwalten
Mit dem Adapter Project Parameter Management lassen sich Projekt-Parameter anlegen und verwalten. Dabei bietet der Adapter verschiedene Operationen zur Verwaltung von Projekt-Parametern, etwa zum Hinzufügen oder Löschen, aber auch zum Import und Export von Parametern oder Parametergruppen.
Projekt-Parameter im X4 Control Center steuern
Während des Betriebs können Fachadministratoren im X4 Control Center über Administration > X4 API (Swagger UI) die Konfiguration von Projekt-Parametern jederzeit einsehen und anpassen. Neue Prozess-Instanzen werden anschließend mit geänderten Parametern ausgeführt.