Projekt-Parameter erstellen

Projekt-Parameter und Projekt-Parameter-Gruppen können in einer projekt-spezifischen Datei mit der Endung *.param (Project Parameter Configuration) erstellt werden.

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.

Hinweis

Beachten Sie bei der Verwendung von Parametern folgende Priorisierung:

System-Parameter → Projekt-Parameter → globale Parameter

Bei Namenskonflikten wird eine Fehlermeldung bzw. Warnung in der Sicht Problems angezeigt:

Fehlermeldung bei Namenskonflikten von System- und Projekt-Parametern
Warnung bei Namenskonflikten von Projekt-Parametern und globalen Parametern

Hinweis

Mit der Tastenkombination Strg+Leertaste können in Projektdateien (Prozessbausteinen, Mappings, Adaptern und Conditions) alle verfügbaren Parameter angezeigt und ausgewählt werden.

Auf dieser Seite finden Sie folgende Inhalte:

Project Parameter Configuration erstellen

So erstellen Sie die Project Parameter Configuration

Wählen Sie ein bestehendes ESB-Projekt und klicken Sie mit der rechten Maustaste auf den Projektordner.
Wählen Sie im Kontextmenü New > Project Parameter Configuration
Eine Datei mit der Endung .param und dem Namen des Projekts wird erstellt:

Projekt-Parameter hinzufügen

Hinweis

Das Bearbeiten von Projekt-Parametern und Projekt-Parameter-Gruppen kann durch Rollen im Authentifizierungsprovider Keycloak eingeschränkt werden (siehe https://www.keycloak.org im Bereich Docs> Server Administration).
Parameter können über die Design-Ansicht oder über die Source-Ansicht direkt in der XML-Struktur hinzugefügt werden.
Parameter vom Typ Enum können über Manage Custom Types erstellt werden. Hier können z. B. Werte für Bedingungen im Condition-Editor eingegeben werden.

So erstellen Sie einen Projekt-Parameter

Öffnen Sie die Project Parameter Configuration.
Im Bereich Parameters, klicken Sie auf Add.

Geben Sie die Eigenschaften für den Parameter ein. Datenfelder mit * sind Pflichtfelder:

Datenfelder	Beschreibung
Name*	Name des Parameters Hinweis Um Namenskonflikte zu vermeiden, muss der Name des Parameters eindeutig sein. Hinweis Der Name des Projekt-Parameters darf keine Sonderzeichen und Punkte enthalten. Folgende Zeichen sind erlaubt: `^[a-zA-Z][a-zA-Z0-9\-]*$`
Type*	Datentyp des Parameters Hinweis Der Typ des Parameters wird bei Erstellung und beim Überschreiben zur Laufzeit geprüft. Auf Basis des Parametertyps werden die Parameterwerte in den Projektdateien genutzt. Mögliche Werte: String Boolean Integer Decimal Date DateTime Password Hinweis Parameter vom Typ Password werden in der Design-Ansicht mit Asterisk und in der Source-Ansicht (XML-Struktur) verschlüsselt angezeigt. Custom Types mit Custom Type Values (Enums)
Value*	Defaultwert des Parameters
Changeable*	Typ des Parameters: Constant oder Variable Hinweis Parameter vom Typ Constant können nicht zur Laufzeit überschrieben werden. Projekt-Parameter vom Typ Variable können zur Laufzeit überschrieben werden. Somit muss der Wert bei Projekt-Parametern vom Typ Variable nicht befüllt werden. Mögliche Werte (Boolean): `true` (variable) `false` (constant)
Access Role	Rolle mit Zugriffsberechtigung zum Editieren des Parameters
Description	Beschreibung des Parameters

Projekt-Parameter-Gruppen hinzufügen

Hinweis

Um Namenskonflikte zu vermeiden, muss der Name des Parameters eindeutig sein.

So erstellen Sie eine Projekt-Parameter-Gruppe

Öffnen Sie die Project Parameter Configuration.
Im Bereich Groups. klicken Sie auf Add.
Eine neue Projekt-Parameter-Gruppe wird erstellt:

Projekt-Parameter-Gruppen lassen sich beliebig verschachteln:

Beispiel einer Project Parameter Configuration

Project Parameter Configuration mit Constant und Variable auf Root Level

Project Parameter Configuration mit Projekt-Parameter-Gruppe

Beispiel der XML-Struktur

Beispiel für die XML-Struktur einer Project Parameter Configuration:

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Parameters xmlns="http://softproject.de/parameter/1.0">
	<Enums />
	<Group name="GroupWithVariables">
		<VariableParameter name="Boolean" type="Boolean">
			<Value>true</Value>
		</VariableParameter>
		<VariableParameter name="Date" type="Date">
			<Value>2023-01-30</Value>
		</VariableParameter>
		<VariableParameter name="DateTime" type="DateTime">
			<Value>2023-01-31T12:30:00</Value>
		</VariableParameter>
		<VariableParameter name="Integer" type="Integer">
			<Value>100</Value>
		</VariableParameter>
		<VariableParameter name="Decimal" type="Decimal">
			<Value>1.5</Value>
		</VariableParameter>
		<VariableParameter name="Password" type="Password">
			<Value>R8hr/okHDzHH1qXCST+aSYJH8auXU86Nhjtw1XVek38sLyFyFM/KCQM0kVybKJ6EergBHrrtBygJRhWetw==</Value>
		</VariableParameter>
		<VariableParameter name="String" type="String">
			<Value>some text</Value>
		</VariableParameter>
		<VariableParameter name="Multiline"
			type="MultilineText">
			<Value>MultilineText
				   MultilineText
				   MultilineText
			</Value>
		</VariableParameter>
	</Group>
	<ConstantParameter name="Constant" type="String">
		<Value>I am a constant</Value>
	</ConstantParameter>
	<VariableParameter name="Variable" type="String">
		<Value>I am a variable</Value>
	</VariableParameter>
</Parameters>