Creating Project Parameters

Project parameters and project parameter groups can be created in a project-specific file with the extension *.param (Project Parameter Configuration).

Project parameters can then be used just like global and system parameters in the X4 Designer (in the editors of adapters, mappings, processes, conditions, and the Properties view) and can be exported or imported with the project.

Project parameters and project parameter groups are loaded at server startup and deployed with the respective project.

They can be changed and persisted at runtime via ReST API, X4 adapters or Web Apps.

Note

Observe the following prioritization when using parameters:

System parameters → Project parameters → Global parameters.

In case of name conflicts, an error message or warning is displayed in the Problems view:

Error message in case of name conflicts of system and project parameters
Warning in case of name conflicts of project parameters and global parameters

Note

With the shortcut CTRL+SPACE all available parameters (global, system and project parameters) are displayed in process components, mappings, adapters, and conditions.

Creating the Project Parameter Configuration

How to create the Project Parameter Configuration

Select an existing ESB project and right-click the project folder to open the context menu.
In the context menu, select New > Project Parameter Configuration
A file with the extension .param and the name of the project is created:

Adding Project Parameters

Note

Editing of project parameters and project parameter groups can be restricted by roles in the authentication provider Keycloak (see https://www.keycloak.org in the section Docs > Server Administration).
Parameters can be added in the Designer in the Project Parameter Configuration via the Design view (recommended) or directly in the XML structure via Source view.
Custom Types (Enums) can be created via Manage Custom Types. Here, for example, values for conditions can be created and then used in the Condition Editor (see Manage Custom Types).

How to create project parameters

Open the Project Parameter Configuration.
In the pane Parameters, click Add.

Enter the properties for the project parameter. Data fields with * are mandatory fields:

Data field	Description
Name*	Name of the parameter Note To avoid name conflicts, the name of the parameter must be unique. Note The name of the project parameter must start with a letter, must not contain special characters and dots. The following characters are allowed: `^[A-Za-z_][A-Za-z0-9-_]$` Valid example*: `My-Project-Parameter-123`
Type*	Data type of the parameter Note The type of the parameter is checked when it is created and when it is overwritten at runtime. Based on the parameter type, the parameter values are used in the project files. Possible values: String Boolean Integer Decimal Date DateTime Password Note Password type parameters are displayed in the Design view with asterisk and in the Source view (XML structure) encrypted. Custom Types with Custom Type Values (Enums)
Value*	Default value of the parameter
Changeable*	Type of the parameter: Constant or Variable Note Parameters of type Constant cannot be overwritten at runtime. Project parameters of type Variable can be overwritten at runtime. Thus, the value does not have to be filled for project parameters of the type Variable. Possible values (Boolean): `true` (variable) `false` (constant)
Access Role	Role with access rights to edit the parameter
Description	Description of the parameter

Adding Project Parameter Groups

Note

To avoid name conflicts, the name of the parameter must be unique.

How to create a project parameter group

Open the Project Parameter Configuration.
In the pane Groups, click Add.
A new project parameter group is created:

Project parameter groups can be nested as desired:

Example of a Project Parameter Configuration

Project Parameter Configuration with Constant and Variable at Root Level

Project Parameter Configuration with Project Parameter Group

Example of an XML Structure

Example of XML structure of a 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>