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, where you can add project-specific parameters and parameter groups.
In addition, you can declare Custom Types (Enums) with Custom Type Values there, which you can select later when creating a project parameter. A possible use case of Custom Types with Custom Type Values is the definition of conditions in the Condition Editor (see Creating and Using Conditions).
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 modified and persisted at runtime via ReST API, X4 Adapter or Web Apps.
Benefits of project parameters
- Reusability of components through parameterization is increased.
- The process can be influenced directly at runtime by project parameters.
- With the
*.paramfile, project parameters can be exported or imported directly with the project. - Via the X4 Control Center (Swagger UI) or via a special adapter, the Project Parameter Management adapter, project parameters can be changed at runtime
- Project parameters, just like system and global parameters, can be used in mappings, conditions and other process components, such as adapters, as well as in business rules or human tasks (BPM projects).
- Global parameters can be copied to the Project Parameter Configuration in order to be used there in a project-specific way (see Copying global parameters to project parameters).
Special features of project parameters
- Scoping: A parameter value can be shared by all processes or be different for each process execution.
- Password encryption: Project parameters of Type
Passwordare encrypted by a runtime mechanism. No passwords should be configured in the file at development time. - Read only: A parameter can be defined as read-only, i.e. as a constant, so that it cannot be changed at runtime.
- 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 (i.e. description) provides information about the parameter for configuration purposes
- X4 Control Center: The X4 Control Center (Swagger UI) can be used to view and adjust all parameters that the currently logged in user is allowed to see or edit.
Managing Project Parameters via the Adapter Project Parameter Management
The adapter Project Parameter Management can be used to create and manage project parameters. The adapter offers various operations for managing project parameters, such as adding or deleting, but also importing and exporting parameters or parameter groups.
Controlling Project Parameters in the X4 Control Center
During operation, administrators can view and adjust the project parameter configuration in the X4 Control Center at any time via Administration > X4 API (Swagger UI). New process instances are then executed with modified parameters.