X4 Help Center
X4 Help Center
Breadcrumbs

Project Parameters

How can I use project parameters?

In an existing project, you can create the Project Parameter Configuration, a file with the extension *.param, with project-specific parameters and parameter groups.

You can also declare custom types (enums) with custom type values, which you can select later when creating a project parameter. A possible use case of Custom Types with Custom Type Values are conditions with Condition components (see Creating and Using Conditions ).

Project parameters can then be used as global and system parameters in the X4 Designer tools (Adapter Editor, Mapping Editor, Process Editor, Condition Editor, Properties View) and can be exported or imported with the project.

Project parameters and project parameter groups are loaded when the server is started and deployed with the respective project.

They can be modified and persisted at runtime via REST API, X4 Adapter or Web Apps.

Advantages of Project Parameters

  • The reusability of components is increased by parameterization.

  • The process can be influenced by project parameters directly at runtime.

  • Project parameters can be exported or imported directly with the project using the *.param file.

  • Project parameters can be changed at runtime via the X4 Control Center (Swagger UI) or via a special adapter, the Project Parameter Management adapter.

  • Project parameters can be used in mappings, conditions and other configurations, such as adapters, as well as in business rules or human tasks (BPM projects), just like system and global parameters.

  • Global parameters can be copied to the Project Parameter Configuration for project-specific use, see Copying Global Parameters to Project Parameters .

Special features of project parameters

  • Scoping: A parameter value can be shared by all processes or different for each process execution.

  • Password encryption: Password project parameters are encrypted using a runtime mechanism. At development time, passwords should not be configured in the file.

  • Constant (read-only) parameters: A parameter can be defined as read-only so that it cannot be changed at run time.

  • Access restriction: You can specify that a parameter can only be edited by users with a specific role in the authentication provider Keycloak (see https://www.keycloak.org in the Docs > Server Administration section).

  • Metadata: Metadata (description) provide information about the parameter for the configuration.

  • X4 Control Center: The X4 Control Center (Swagger UI) can be used to display all parameters that the currently logged-on user is allowed to view or edit.


Additional information:

Managing project parameters via the Project Parameter Management adapter

Project parameters can be created and managed with the Project Parameter Management adapter. The adapter provides various operations for managing project parameters, for example, adding or deleting, but also for importing and exporting parameters or parameter groups.

Controlling project parameters in the X4 Control Center

During operation, specialist administrators can view and adapt the configuration of project parameters at any time in the X4 Control Center via Administration > X4 API (Swagger UI). New process instances are then executed with modified parameters.