Parameterization Options

Here you get an overview of all options to parameterize a process component.

Scope of parameters

System parameters: Parameters provided by the system (see System Parameters)
Global parameters: Parameters that you can create as a user and that can be used in all projects of the X4 BPMS (see Global Parameters)
Project parameters: Parameters that can be created in a specific file in a project, used within this project and imported or exported with the project (see Project Parameters)

Using parameters

Parameters can be used in Technical Processes in process components, mappings, adapters, and conditions. In business processes (BPM processes), parameters can be used in rules and human tasks. Global, system or project parameters can be used.

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

Note 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

Where are parameters saved?

System parameters	The X4 BPMS contains a number of predefined system parameters, e.g. `%PID%` (current process ID) or `%NOW%` (current date and time). System parameters cannot be changed during runtime. Typical use case: Set technical parameters, e.g. a mail server address, for this runtime environment/stage Output a file name or the process ID of a technical process
For additional use cases not covered by system parameters, you can create global or project parameters. Global or project parameters, unlike system parameters, can be set at runtime.
Global parameters	You can define global parameters in the Global Parameter Configuration. This configuration is stored in the respective process. For examples of use cases of global parameters, see Using global parameters. Typical use case: Set parameters that are used in different projects and that can be changed during runtime, e.g. the recipients of system-generated mails or the footer in system-generated mails.
Project parameters	Project parameters can be used in multiple Technical Processes in a project. These parameters are stored in the Project Parameter Configuration (`.param`) in the project and can be exported or imported with the project. Typical use cases:* Technical Process: A project parameter can be defined as a limit for measured values (measured value must be between two limits). Business Process with Business Rule: A project parameter can be defined as a limit for checking a value (acceptance/rejection depending on the set value). Business Process with Human Task: A project parameter can be set in a mapping in a Technical Process that is called by the business process. Here, for example, the duration in the Human Task can be different depending on the environment.

Where are parameters used?

In Technical Processes, parameters can be set for the following components:

Adapters
Conditions
Mappings
further process components

In business processes (BPM processes), parameters can be set for the following components:

Rules
Human Task (via mapping in a Technical Process)

When parameterizing, the following priority cascade is applied:

Component Parameters overwrite the process component configuration from the repository (e.g. an adapter) during process runtime.
Dynamic parameters overwrite set parameters (global, project and system parameters) as well as the process component configuration from the repository (e.g. an adapter) during process runtime.

Action	Description
Parameters in Adapters	Parameters can be used in the configuration of adapters. Typical use case: In an XML Encryption (Password) adapter, a path to an element that is to be encrypted/decrypted can be set in the XPath parameter. This path can be fixed (`//Data`) or set via a parameter.
Conditions	You can define case distinctions in branches of condition components with parameters (see Creating and using conditions). Typical use case: It is to be checked whether the output of a process contains a certain parameter value.
Mappings	Parameters (global, project and system parameters) can be used in XSL mappings. For being available for use, they have to be included in the mapping (see Using parameters in XSL mappings).
Component Parameter	You can adjust selected components of an open process in the Properties view. With Component Parameters, you can parameterize a marked component for the individual process (see Component Parameters). These parameters are stored in the respective process. Typical use case: Component Parameters can be used to overwrite the parameters of an adapter in a process. As Component Parameters you can use fixed values (fixed path e.g. `//Data`) or parameters. System parameters or previously defined global or project parameters can be used here.
Dynamic Parameter	You can use dynamic parameters to overwrite global, system, and project parameters in XSL mappings. Within a process, you can use dynamic parameters to control different process modules depending on the processed data. Dynamic parameters are stored in XSL mappings in the form of processing instructions and interpreted by the subsequent process module, e.g. an adapter (see Setting dynamic parameters). The configuration is only changed dynamically during the process runtime. Typical use case: You can use dynamic parameters to control process modules and overwrite parameters that have already been set at process runtime.