Chapter 20. KIE Server system properties
KIE Server accepts the following system properties (bootstrap switches) to configure the behavior of the server:
Table 20.1. System properties for disabling KIE Server extensions
Property | Values | Default | Description |
---|---|---|---|
|
|
|
If set to |
|
|
|
If set to |
|
|
|
If set to |
|
|
|
If set to |
|
|
|
If set to |
|
|
|
If set to |
|
|
|
If set to |
|
|
|
If set to |
|
|
|
If set to |
Some Process Automation Manager controller properties listed in the following table are marked as required. Set these properties when you create or remove KIE Server containers in Business Central. If you use KIE Server separately without any interaction with Business Central, you do not need to set the required properties.
Table 20.2. System properties required for Process Automation Manager controller
Property | Values | Default | Description |
---|---|---|---|
| String | N/A | An arbitrary ID to be assigned to the server. If a headless Process Automation Manager controller is configured outside of Business Central, this is the ID under which the server connects to the headless Process Automation Manager controller to fetch the KIE container configurations. If not provided, the ID is automatically generated. |
| String |
| The user name used to connect with KIE Server from the Process Automation Manager controller, required when running in managed mode. Set this property in Business Central system properties. Set this property when using a Process Automation Manager controller. |
| String |
| The password used to connect with KIE Server from the Process Automation Manager controller, required when running in managed mode. Set this property in Business Central system properties. Set this property when using a Process Automation Manager controller. |
| String | N/A | A property that enables you to use token-based authentication between the Process Automation Manager controller and KIE Server instead of the basic user name and password authentication. The Process Automation Manager controller sends the token as a parameter in the request header. The server requires long-lived access tokens because the tokens are not refreshed. |
| URL | N/A |
The URL of the KIE Server instance used by the Process Automation Manager controller to call back on this server, for example, |
| Comma-separated list | N/A |
A comma-separated list of URLs to the Process Automation Manager controller REST endpoints, for example, |
| String |
| The user name to connect to the Process Automation Manager controller REST API. Setting this property is required when using a Process Automation Manager controller. |
| String |
| The password to connect to the Process Automation Manager controller REST API. Setting this property is required when using a Process Automation Manager controller. |
| String | N/A | A property that enables you to use token-based authentication between KIE Server and the Process Automation Manager controller instead of the basic user name and password authentication. The server sends the token as a parameter in the request header. The server requires long-lived access tokens because the tokens are not refreshed. |
| Long |
| The waiting time in milliseconds between repeated attempts to connect KIE Server to the Process Automation Manager controller when the server starts. |
Table 20.3. Persistence system properties
Property | Values | Default | Description |
---|---|---|---|
| String | N/A | A data source JNDI name. Set this property when enabling the BPM support. |
| String | N/A | A transaction manager platform for Hibernate properties. Set this property when enabling the BPM support. |
| String | N/A | The Hibernate dialect to be used. Set this property when enabling the BPM support. |
| String | N/A | The database schema to be used. |
Table 20.4. Executor system properties
Property | Values | Default | Description |
---|---|---|---|
| Integer |
|
The time between the moment the Red Hat Process Automation Manager executor finishes a job and the moment it starts a new one, in a time unit specified in the |
|
|
|
The time unit in which the |
| Integer |
| The number of threads used by the Red Hat Process Automation Manager executor. |
| Integer |
| The number of retries the Red Hat Process Automation Manager executor attempts on a failed job. |
| String |
| Job executor JMS queue for KIE Server. |
|
|
|
If set to |
|
|
|
If set to |
Table 20.5. Human task system properties
Property | Values | Default | Description |
---|---|---|---|
|
|
| A property that specifies the implementation of user group callback to be used:
|
| Fully qualified name | N/A |
A custom implementation of the |
|
|
| Enables task cleanup job listener to remove tasks once the process instance is completed. |
|
|
| Enables task BAM module to store task related information. |
| String |
| User who can access all the tasks from KIE Server. |
| String |
| The group that users must belong to in order to view all the tasks from KIE Server. |
Table 20.6. System properties for loading keystore
Property | Values | Default | Description |
---|---|---|---|
| URL | N/A |
The URL is used to load a Java Cryptography Extension KeyStore (JCEKS). For example, |
| String | N/A | The password is used for the JCEKS. |
| String | N/A | The alias name of the key for REST services where the password is stored. |
| String | N/A | The password of an alias for REST services. |
| String | N/A | The alias of the key for default REST Process Automation Manager controller. |
| String | N/A | The password of an alias for default REST Process Automation Manager controller. |
Table 20.7. System properties for retrying committing transactions
Property | Values | Default | Description |
---|---|---|---|
| Integer | 5 | This property describes how many times the process engine retries a transaction before failing permanently. |
| Integer | 50 | The delay time before the first retry, in milliseconds. |
| Integer | 4 | The multiplier for increasing the delay time for each subsequent retry. With the default values, the process engine waits 50 milliseconds before the first retry, 200 milliseconds before the second retry, 800 milliseconds before the third retry, and so on. |
Table 20.8. Other system properties
Property | Values | Default | Description |
---|---|---|---|
| Path | N/A |
The location of a custom |
| String |
| The response queue JNDI name for JMS. |
|
|
|
When set to |
|
|
| A property that enables you to bypass the authenticated user for task-related operations, for example queries. |
| Integer |
| This property specifies the maximum number of executed rules to avoid situations where rules run into an infinite loop and make the server completely unresponsive. |
|
|
| This property turns off the EJB Timers local cache. |
| String | N/A |
The JAAS |
| Path |
| The location where KIE Server state files are stored. |
|
|
| A property that instructs KIE Server to hold the deployment until the Process Automation Manager controller provides the container deployment configuration. This property only affects servers running in managed mode. The following options are available:
* |
|
|
| The Startup strategy of KIE Server used to control the KIE containers that are deployed and the order in which they are deployed. |
|
|
|
When set to |
|
Java packages like | N/A | A property that specifies additional packages to allowlist for marshalling using XStream. |
| String |
|
Fully qualified name of the class that implements |
|
|
|
While using JSON marshalling, if the property is set to |
|
|
|
When the value of this property is set to |