红帽全球峰会此内容没有您所选择的语言版本。
Appendix A. Configuration Properties
This chapter contains all public system properties and KIE environment entries that you can use to configure your deployment of Red Hat JBoss BPM Suite.
A.1. System Properties
System properties configure the entire JVM Red Hat JBoss BPM Suite runs on. You can either provide them at runtime, or set them in the configuration XML file for your deployment.
A.1.1. Runtime Configuration
To set a particular property at runtime, add a flag -D with the property’s name and value when starting the server. You can list multiple such properties at the same time.
Configuring System Properties at Runtime (Standalone deployments)
-
Navigate to
SERVER_HOME/bin. Run the server with the desired flags:
./standalone.sh -Dorg.kie.custom.property=value -Dorg.uberfire.switch=false
./standalone.sh -Dorg.kie.custom.property=value -Dorg.uberfire.switch=falseCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteOn Windows, run
standalone.batinstead ofstandalone.sh.
A.1.2. XML Configuration
To set a property in Red Hat JBoss BPM Suite configuration, add an entry under the <system-properties> section in the standalone.xml file:
<system-properties> <property name="org.kie.custom.property" value="random_value"/> <property name="org.uberfire.switch" value="false"/> ... </system-properties>
<system-properties>
<property name="org.kie.custom.property" value="random_value"/>
<property name="org.uberfire.switch" value="false"/>
...
</system-properties>
When running Red Hat JBoss BPM Suite in domain mode, add the entries in the <system-properties> element of the appropriate node in the host.xml file.
A.1.3. List of System Properties
This section contains the alphabetically sorted list of all recognized system properties in Red Hat JBoss BPM Suite 6.3.
Red Hat JBoss BPM Suite System Properties
- btm.root
Root directory for Bitronix Transaction Manager. The discovery of configuration and other files starts in this location.
Expand Values Default String
N/A
- drools.propertySpecific
Sets property reactivity behavior of the Red Hat JBoss BPM Suite engine. Options are following:
-
DISABLED: Property reactivity turned off. -
ALLOWED: Property reactivity allowed. -
ALWAYS: Property reactivity always on.
Expand Values Default DISABLED,ALLOWED, orALWAYSALLOWED-
- drools.ruleEngine
Specifies which algorithm the Red Hat JBoss BPM Suite rule engine should use.
Expand Values Default phreakorreteoophreak- drools.sequential
Enables sequential mode for stateless sessions.
Expand Values Default trueorfalsefalse- drools.sequential.agenda
Selects static or dynamic agenda with sequential mode.
Expand Values Default staticordynamicstaticfor standard mode,dynamicfor sequential mode- jboss.node.name
A node name unique in a Red Hat JBoss BPM Suite cluster.
Expand Values Default String
N/A
- jbpm.audit.jms.connection.factory
A link to a JMS connection factory instance.
Expand Values Default A
javax.jms.ConnectionFactoryinstanceN/A
- jbpm.audit.jms.connection.factory.jndi
The JNDI name of the connection factory to look up.
Expand Values Default String
N/A
- jbpm.audit.jms.enabled
Indicates if audit mode is set to JMS.
Expand Values Default trueif Audit mode is set to JMS, otherwisefalseN/A
- jbpm.audit.jms.queue
A JMS Queue instance to be used when creating JMS AuditLogger.
Expand Values Default A
javax.jms.QueueinstanceN/A
- jbpm.audit.jms.queue.jndi
The JNDI name of the JMS queue to look up.
Expand Values Default String
N/A
- jbpm.audit.jms.transacted
Determines if the JMS session is transacted.
Expand Values Default trueorfalsetrue- jbpm.business.calendar.properties
The location of the configuration file with Business Calendar properties.
Expand Values Default Path
/jbpm.business.calendar.properties- jbpm.data.dir
The location where data files produced by Red Hat JBoss BPM Suite must be stored.
Expand Values Default ${jboss.server.data.dir}if available, otherwise${java.io.tmpdir}${java.io.tmpdir}- jbpm.enable.multi.con
Allows Web Designer to use multiple incoming or outgoing connections for tasks. If not enabled, the tasks are marked as invalid.
Expand Values Default trueorfalsefalse- jbpm.loop.level.disabled
Enables or disables loop iteration tracking to allow advanced loop support when using XOR gateways.
Expand Values Default trueorfalsetrue- jbpm.overdue.timer.delay
Specifies the delay for overdue timers to allow proper initialization, in milliseconds.
Expand Values Default Number (
Long)2000
- jbpm.process.name.comparator
An alternative comparator class to empower the Start Process by Name feature.
Expand Values Default Fully qualified name
org.jbpm.process.instance.StartProcessHelper.NumberVersionComparator- jbpm.tm.jndi.lookup
Allows setting a specific
TransactionManagerJNDI lookup name as a fallback in case a standard JNDI name is not used. Ifjava:comp/UserTransactiondoes not implement theorg.drools.persistence.TransactionManagerinterface, these names are used, in this order:-
java:comp/TransactionManager -
java:appserver/TransactionManager -
java:pm/TransactionManager -
java:TransactionManager - Value of this property
Expand Values Default JNDI name
N/A
-
- jbpm.usergroup.callback.properties
The location of the usegroup callback property file when
org.jbpm.ht.callbackis set tojaasordb.Expand Values Default Path
classpath:/jbpm.usergroup.callback.properties- jbpm.user.group.mapping
An alternative classpath location of user info configuration (used by
LDAPUserInfoImpl).Expand Values Default Path
${jboss.server.config.dir}/roles.properties
- jbpm.user.info.properties
An alternative classpath location for user group callback implementation (LDAP, DB). For more information, see
org.jbpm.ht.userinfo.Expand Values Default Path
classpath:/userinfo.properties- jbpm.ut.jndi.lookup
An alternative JNDI name to be used when there is no access to the default one for user transactions (
java:comp/UserTransaction).Expand Values Default JNDI name
N/A
- jbpm.v5.id.strategy
When enabled, Red Hat JBoss BPM Suite will use the process ID generation strategy from version 5 when migrating to version 6 and newer.
Expand Values Default trueorfalsefalse- kie.maven.settings.custom
The location of a custom
settings.xmlfile for Maven configuration.Expand Values Default Path
N/A
- kie.server.jms.queues.response
The JNDI name of response queue for JMS.
Expand Values Default String
queue/KIE.SERVER.RESPONSE- org.drools.server.ext.disabled
When set to
true, disables the BRM support (for example rules support).Expand Values Default trueorfalsefalse- org.drools.server.filter.classes
When set to
true, the Drools Intelligent Process Server extension accepts custom classes annotated byXmlRootElementorRemotableannotations only.Expand Values Default trueorfalsefalse- org.guvnor.m2repo.dir
The location where Maven artifacts are stored. When you build and deploy a project, it is stored in this directory. Change the setting, for example, to allow easier backup of your maven repository.
Expand Values Default Path
EAP_HOME/repositories/kie- org.guvnor.project.gav.check.disabled
Disables a duplicate
GroupId,ArtifactId, andVersion(GAV) detection. When you build and deploy a project, Business Central scans the Maven repository for an artifact with the same GAV values. If set totrue, Business Central silently overrides any previous project. If set tofalse, the user is required to confirm overriding the old project.Expand Values Default trueorfalsefalse- org.jbpm.deploy.sync.enabled
When enabled, Red Hat JBoss BPM Suite synchronizes KJAR deployments across Business Central nodes in a cluster, and automatically loads previous deployments.
Expand Values Default trueorfalsetrue- org.jbpm.deploy.sync.int
Interval of KJAR deployment synchronization, in seconds.
Expand Values Default Number (
Integer)3
- org.jbpm.ht.callback
Specifies the implementation of user group callback to be used:
-
mvel: Default; mostly used for testing. -
ldap: LDAP; requires additional configuration in thejbpm.usergroup.callback.propertiesfile. -
db: Database; requires additional configuration in thejbpm.usergroup.callback.propertiesfile. -
jaas: JAAS; delegates to the container to fetch information about user data. -
props: A simple property file; requires additional file that will keep all information (users and groups). -
custom: A custom implementation; you must specify the fully qualified name of the class in theorg.jbpm.ht.custom.callback.
Expand Values Default mvel,ldap,db,jaas,props, orcustommvel-
- org.jbpm.ht.custom.callback
A custom implementation of the
UserGroupCallbackinterface in case theorg.jbpm.ht.callbackproperty is set tocustom.Expand Values Default Fully qualified name
N/A
- org.jbpm.ht.custom.userinfo
A custom implementation of the
UserInfointerface in case theorg.jbpm.ht.userinfoproperty is set tocustom.Expand Values Default Fully qualified name
N/A
- org.jbpm.ht.userinfo
Specifies what implementation of the UserInfo interface to use for user or group information providers.
-
ldap: LDAP; needs to be configured in the file specified injbpm-user.info.properties. -
db: Database; needs to be configured in the file specified injbpm-user.info.properties. -
props: A simple property file; set the propertyjbpm.user.info.propertiesto specify the path to the file. -
custom: A custom implementation; you must specify the fully qualified name of the class in theorg.jbpm.ht.custom.userinfoproperty.
Expand Values Default ldap,db,props, orcustomN/A
-
- org.jbpm.ht.user.separator
An alternative separator when loading actors and groups for user tasks from a
String.Expand Values Default String
,(comma)- org.jbpm.rule.task.waitstate
When set to
false, a business rule task automatically fires off all rules instead of waiting to be triggered from the outside. This prevents errors during heavy multithreaded usage.Expand Values Default trueorfalsetrue- org.jbpm.runtime.manager.class
A custom implementation of the
org.kie.api.runtime.manager.RuntimeManagerFactoryinterface.Expand Values Default Fully qualified name
org.jbpm.runtime.manager.impl.RuntimeManagerFactoryImpl- org.jbpm.server.ext.disabled
When set to
true, disables the BPM support (for example, processes support).Expand Values Default trueorfalsefalse- org.jbpm.ui.server.ext.disabled
When set to
true, disables the Intelligent Process Server UI extension.Expand Values Default trueorfalsefalse- org.kie.auto.deploy.enabled
When enabled, issuing a Build & Deploy operation in Business Central always deploys to runtime.
Expand Values Default trueorfalsetrue- org.kie.build.disable-project-explorer
Disables automatic build of the selected project in Project Explorer.
Expand Values Default trueorfalsefalse- org.kie.dd.mergemode
Selects the method for overriding hierarchical merge mode behavior when managing deployment descriptors.
Expand Values Default MERGE_COLLECTIONS,KEEP_ALL,OVERRIDE_ALL, orOVERRIDE_EMPTYMERGE_COLLECTIONS- org.kie.demo
Enables external cloning of a demo application from GitHub. This System Property takes precedence over
org.kie.example.Expand Values Default trueorfalsetrue- org.kie.example
When set to
true, creates an example organization unit and repository. This system property allows you to create projects and assets without creating your custom organization unit and repository. It is useful, for example, to simplify the getting started experience.Expand Values Default trueorfalsefalse- org.kie.example.repositories
Sets the path to the directory containing example repositories. If you set this system property, repositories in the specified directory are automatically cloned into Business Central during startup. This property overrides
org.kie.exampleandorg.kie.demo.WarningYou must download the example repositories from the Customer Portal and extract them to this directory before setting this system property.
Expand Values Default Path
N/A
- org.kie.executor.disabled
Disables the Red Hat JBoss BPM Suite executor.
Expand Values Default trueorfalsefalse- org.kie.executor.initial.delay
The initial delay before the Red Hat JBoss BPM Suite executor starts a job, in milliseconds.
Expand Values Default Number (
Integer)100
- org.kie.executor.interval
The time between the moment the Red Hat JBoss BPM Suite executor finishes a job and the moment it starts a new one, in a time unit specified in
org.kie.executor.timeunit.Expand Values Default Number (
Integer)3
- org.kie.executor.pool.size
The number of threads used by the Red Hat JBoss BPM Suite executor.
Expand Values Default Number (
Integer)1
- org.kie.executor.retry.count
The number of retries the Red Hat JBoss BPM Suite executor attempts on a failed job.
Expand Values Default Number (
Integer)3
- org.kie.executor.timeunit
The time unit in which the
org.kie.executor.intervalis specified.Expand Values Default A
java.util.concurrent.TimeUnitconstantSECONDS- org.kie.git.deployments.enabled
When enabled, Red Hat JBoss BPM Suite uses a Git repository for storing deployments instead of a database.
Expand Values Default trueorfalsefalse- org.kie.mail.debug
When enabled,
EmailWorkItemHandlerproduces debug logging forjavax.mail.Session.Expand Values Default trueorfalsefalse- org.kie.mail.session
The JNDI name of the mail session as registered in the application server, for use by
EmailWorkItemHandler.Expand Values Default String
mail/jbpmMailSession- org.kie.override.deploy.enabled
Allows overwriting deployments with the same GAV (not allowed by default).
Expand Values Default trueorfalsefalse- org.kie.server.bypass.auth.user
Allows to bypass the authenticated user for task-related operations, for example queries.
Expand Values Default trueorfalsefalse- org.kie.server.controller
A comma-separated list of URLs to controller REST endpoints, for example
http://localhost:8080/business-central/rest/controller. This property is required when using a controller.Expand Values Default Comma-separated list
N/A
- org.kie.server.controller.connect
The waiting time between repeated attempts to connect Intelligent Process Server to the controller when Intelligent Process Server starts up, in milliseconds.
Expand Values Default Number (
Long)10000- org.kie.server.controller.pwd
The password to connect to the controller REST API. This property is required when using a controller.
Expand Values Default String
kieserver1!- org.kie.server.controller.token
This property allows you to use a token-based authentication between the KIE server and the controller instead of the basic user name/password authentication. The KIE server sends the token as a parameter in the request header. Note that long-lived access tokens are required as the tokens are not refreshed.
Expand Values Default String
N/A
- org.kie.server.controller.user
The user name to connect to the controller REST API. This property is required when using a controller.
Expand Values Default String
kieserver- org.kie.server.domain
The JAAS
LoginContextdomain used to authenticate users when using JMS.Expand Values Default String
N/A
- org.kie.server.id
An arbitrary ID to be assigned to this server. If a remote controller is configured, this is the ID under which the server will connect to the controller to fetch the KIE container configurations. If not provided, the ID is automatically generated.
Expand Values Default String
N/A
- org.kie.server.location
The URL of the Intelligent Process Server instance used by the controller to call back on this server, for example:
http://localhost:8230/kie-server/services/rest/server. This property is required when using a controller.Expand Values Default URL
N/A
- org.kie.server.persistence.dialect
The Hibernate dialect to be used. You must set this property when enabling BPM support.
Expand Values Default String
N/A
- org.kie.server.persistence.ds
A data source JNDI name. You must set this property when enabling BPM support.
Expand Values Default String
N/A
- org.kie.server.persistence.schema
The database schema to be used.
Expand Values Default String
N/A
- org.kie.server.persistence.tm
A transaction manager platform for Hibernate properties set. You must set this property when enabling BPM support.
Expand Values Default String
N/A
- org.kie.server.pwd
The password used to connect with the KIE server from the controller, required when running in managed mode. You must set this property in Business Central system properties, and it is required when using a controller.
Expand Values Default String
kieserver1!- org.kie.server.repo
The location where Intelligent Process Server state files will be stored.
Expand Values Default Path
.- org.kie.server.sync.deploy
Instructs the KIE server to hold the deployment until the controller provides the containers deployment configuration. This property affects only the KIE servers running in managed mode. The options are as follows:
-
false; the connection to the controller is asynchronous. The application starts, connects to the controller and once successful, deploys the containers. The application accepts requests even before the containers are available. true; the deployment of the KIE server application joins the controller connection thread with the main deployment and awaits its completion.This option can lead to a potential deadlock in case more applications are on the same server instance. It is strongly recommended to use only one application (the KIE server) on one server instance.
Expand Values Default trueorfalsefalse-
- org.kie.server.token
This property allows you to use a token-based authentication between the controller and the KIE server instead of the basic user name/password authentication. The controller sends the token as a parameter in the request header. Note that long-lived access tokens are required as the tokens are not refreshed.
Expand Values Default String
N/A
- org.kie.server.user
The user name used to connect with the KIE server from the controller, required when running in managed mode. This property need to be set in Business Central system properties and is required when using a controller.
Expand Values Default String
kieserver- org.kie.task.insecure
Allows an authenticated user to work on tasks on behalf of other users through the Business Central runtime remote API.
Expand Values Default trueorfalsefalse- org.kie.timer.ejb.disabled
If you select the Singleton runtime strategy and use the EJB executor of your application server to handle timer events, a race condition may occur since the EJB executor completes a transaction outside the
KieSession. Set this property totrueto use the EJB executor bundled with Red Hat JBoss BPM Suite, which prevents this situation from happening.Expand Values Default trueorfalsefalse- org.kie.tx.lock.enabled
When enabled, Red Hat JBoss BPM Suite uses an interceptor that locks the
KieSessionto a single thread for the duration of a transaction, which prevents concurrency errors in Container Managed Transaction (CMT) environments.Expand Values Default trueorfalsefalse- org.kie.verification.disable-dtable-realtime-verification
Disables Business Central’s decision table verification and validation feature.
Expand Values Default trueorfalsefalse- org.optaplanner.server.ext.disabled
When set to
true, disables the BRP support (for example planner support).Expand Values Default trueorfalsefalse- org.quartz.properties
The location of the Quartz configuration file to activate the Quartz timer service.
Expand Values Default Path
N/A
- org.uberfire.cluster.autostart
Delays VFS clustering until the application is fully initialized to avoid conflicts when all cluster members create local clones.
Expand Values Default trueorfalsefalse- org.uberfire.cluster.id
The name of the Helix cluster, for example:
kie-cluster. You must set this property to the same value as defined in the Helix Controller.Expand Values Default String
N/A
- org.uberfire.cluster.local.id
The unique ID of the Helix cluster node. Note that ':' is replaced with '_', for example
node1_12345.Expand Values Default String
N/A
- org.uberfire.cluster.vfs.lock
The name of the resource defined on the Helix cluster, for example:
kie-vfs.Expand Values Default String
N/A
- org.uberfire.cluster.zk
The location of the Zookeeper servers.
Expand Values Default String of the form
host1:port1,host2:port2,host3:port3,…N/A
- org.uberfire.domain
The security domain name for Business Central. For more information about security domains, see chapter Use a Security Domain in Your Application of the Red Hat JBoss EAP Security Guide.
Expand Values Default String
ApplicationRealm- org.uberfire.metadata.index.dir
The location of the
.indexdirectory, which Apache Lucene uses when indexing and searching.Expand Values Default Path
Current working directory
- org.uberfire.nio.git.daemon.enabled
Enables the Git daemon.
Expand Values Default trueorfalsetrue- org.uberfire.nio.git.daemon.host
If the Git daemon is enabled, it uses this property as the localhost identifier.
Expand Values Default URL
localhost- org.uberfire.nio.git.daemon.hostport
When running in a virtualized environment, the host’s outside port number for the Git daemon.
Expand Values Default Port number
9418
- org.uberfire.nio.git.daemon.port
If the Git daemon is enabled, it uses this property as the port number.
Expand Values Default Port number
9418
- org.uberfire.nio.git.dir
The location of the directory
.niogit. Change the value for example for backup purposes.Expand Values Default Path
Current working directory
- org.uberfire.nio.git.hooks
The location where default Git hook files are stored. These files will be copied to newly created Git repositories.
Expand Values Default Path
N/A
- org.uberfire.nio.git.ssh.cert.dir
The location of the directory
.security. Local certificates are stored here.Expand Values Default Path
Current working directory
- org.uberfire.nio.git.ssh.enabled
Enables the SSH daemon.
Expand Values Default trueorfalsetrue- org.uberfire.nio.git.ssh.host
If the SSH daemon is enabled, it uses this property as the localhost identifier.
Expand Values Default URL
localhost- org.uberfire.nio.git.ssh.hostport
When running in a virtualized environment, the host’s outside port number for the SSH daemon.
Expand Values Default Port number
8003
- org.uberfire.nio.git.ssh.passphrase
The passphrase to access your operating system’s public keystore when cloning Git repositories with scp-style URLs, for example
git@github.com:user/repository.git.Expand Values Default String
N/A
- org.uberfire.nio.git.ssh.port
If the SSH daemon is enabled, it uses this property as the port number.
Expand Values Default Port number
8001- org.uberfire.secure.alg
The crypto algorithm used by password encryption.
Expand Values Default String
PBEWithMD5AndDES- org.uberfire.secure.key
A secret password used by password encryption.
Expand Values Default String
org.uberfire.admin- org.uberfire.sys.repo.monitor.disabled
Disables the configuration monitor.
WarningDo not use unless you are certain what you are doing.
Expand Values Default trueorfalsefalse
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}