Question

作为Spring Boot应用，Flowable UI应用可以使用Spring Boot提供的全部参数。 参阅Spring Boot文档的显式配置章节，了解如何进行自定义配置。

提示：也可以使用YAML格式的配置文件。

Table 3. 通用UI应用参数

参数名	原参数	默认值	描述
flowable.common.app.idm-url	idm.app.url	-	IDM应用的URL，用于获取用户信息与令牌信息的REST GET调用。也用做UI应用重定向的登录页。
flowable.common.app.idm-redirect-url	idm.app.redirect.url	-	IDM应用的重定向URL，在未设置cookie或cookie失效时，重定向至该页面进行登录。
flowable.common.app.redirect-on-auth-success	app.redirect.url.on.authsuccess	-	登录成功后需要重定向的页面URL。
flowable.common.app.role-prefix	-	ROLE_	Spring Security需要的默认角色前缀。
flowable.common.app.tenant-id	-	-	DefaultTenantProvider所用的静态租户id。modeler用来判断需要将模型存储及发布在哪个租户id下。 当未设置该值、值为空，或只包含空白时：如果能够获取用户的租户id，则会使用该租户id；否则不使用租户id。
flowable.common.app.cache-login-tokens.max-age	cache.login-tokens.max.age	30	login token的缓存时间，以秒记。
flowable.common.app.cache-login-tokens.max-size	cache.login-tokens.max.size	2048	login token缓存的最大尺寸。
flowable.common.app.cache-login-users.max-age	cache.login-users.max.age	30	login user的缓存时间，以秒记。
flowable.common.app.cache-login-users.max-size	cache.login-users.max.size	2048	login user缓存的最大尺寸。
flowable.common.app.cache-users.max-age	cache.users.max.age	30	user的缓存时间，以秒记。
flowable.common.app.cache-users.max-size	cache.users.max.size	2048	user缓存的最大尺寸。
flowable.common.app.idm-admin.password	idm.admin.password	test	对IDM REST服务进行REST调用（使用基础认证）的密码。
flowable.common.app.idm-admin.user	idm.admin.user	admin	对IDM REST服务进行REST调用（使用基础认证）的用户名。
flowable.rest.app.authentication-mode	rest.authentication.mode	verify-privilege	配置REST API验证用户身份的方式： any-user ：用户存在且密码匹配。任何用户都可以进行调用（6.3.0之前的方式） verify-privilege :用户存在且密码匹配，并且用户拥有rest-api权限

一些旧参数改由Flowable Spring Boot starter（或Spring Boot）进行管理

Table 4. 由Flowable Spring Boot Starter管理的旧参数

参数名	原参数	默认值	描述
flowable.async-executor-activate	engine.process.asyncexecutor.activate	true	是否启用异步执行器。
flowable.database-schema-update	engine.process.schema.update	true	是否执行数据库表结构升级。
flowable.history-level	engine.process.history.level	-	历史级别。
flowable.process.servlet.name	flowable.rest-api-servlet-name	Flowable BPMN Rest API	流程servlet的名字。
flowable.process.servlet.path	flowable.rest-api-mapping	/process-api	流程REST servlet的上下文路径。
flowable.content.storage.create-root	contentstorage.fs.create-root	true	如果root目录不存在，是否需要创建它？
flowable.content.storage.root-folder	contentstorage.fs.root-folder	-	存储内容文件（任务附件、表单上传文件等）的root目录。
flowable.idm.enabled	flowable.db-identity-used	true	是否启动IDM引擎。
flowable.idm.password-encoder	security.passwordencoder	-	密码加密方式。
flowable.idm.ldap.base-dn	ldap.basedn	-	查询用户及组的基础DN（标识名 distinguished name）。如果用户及组使用不同的基础DN，请改用user-base-dn及group-base-dn。
flowable.idm.ldap.enabled	ldap.enabled	false	是否启用LDAP IDM服务。
flowable.idm.ldap.password	ldap.password	-	连接LDAP系统所用的密码。
flowable.idm.ldap.port	ldap.port	-1	LDAP系统的端口号。
flowable.idm.ldap.server	ldap.server	-	LDAP系统所在的服务器地址。例如ldap://localhost。
flowable.idm.ldap.user	ldap.user	-	连接LDAP系统所用的用户ID。
flowable.idm.ldap.attribute.email	ldap.attribute.email	-	代表用户邮件地址的LDAP属性名。用于查询并将LDAP对象映射至Flowable org.flowable.idm.api.User对象。
flowable.idm.ldap.attribute.first-name	ldap.attribute.firstname	-	代表用户名字的LDAP属性名。用于查询并将LDAP对象映射至Flowable org.flowable.idm.api.User对象。
flowable.idm.ldap.attribute.group-id	ldap.attribute.groupid	-	代表用户组ID的LDAP属性名。用于查询并将LDAP对象映射至Flowable org.flowable.idm.api.Group对象。
flowable.idm.ldap.attribute.group-name	ldap.attribute.groupname	-	代表用户组名称的LDAP属性名。用于查询并将LDAP对象映射至Flowable org.flowable.idm.api.Group对象。
flowable.idm.ldap.attribute.last-name	ldap.attribute.lastname	-	代表用户姓的LDAP属性名。用于查询并将LDAP对象映射至Flowable org.flowable.idm.api.User对象。
flowable.idm.ldap.attribute.user-id	ldap.attribute.userid	-	代表用户ID的LDAP属性名。用于查询并将LDAP对象映射至Flowable org.flowable.idm.api.User对象。仅在使用Flowable API查询org.flowable.idm.api.User对象时需要设置。
flowable.idm.ldap.cache.group-size	ldap.cache.groupsize	-1	设置org.flowable.ldap.LDAPGroupCache缓存的尺寸。 这是用户所在组的LRU缓存。避免每次需要查询用户所在组时都访问LDAP系统。 若值小于0，则不会启用缓存。默认值为-1，所以不会进行缓存。 请注意组缓存在org.flowable.ldap.LDAPIdentityServiceImpl中初始化。 因此，自行实现org.flowable.ldap.LDAPIdentityServiceImpl时，请不要忘记添加组缓存功能。
flowable.idm.ldap.query.all-groups	ldap.query.groupall	-	查询所有组所用的语句。
flowable.idm.ldap.query.all-users	ldap.query.userall	-	查询所有用户所用的语句。
flowable.idm.ldap.query.groups-for-user	ldap.query.groupsforuser	-	查询给定用户所在组所用的语句。 比如：(&(objectClass=groupOfUniqueNames)(uniqueMember={0})) 返回LDAP中所有groupOfUniqueNames类、DN为uniqueMember的对象。 上例中，使用{@link java.text.MessageFormat}即{0}注入用户ID。 如果不能通过简单的语句进行查询，可以改用 org.flowable.ldap.LDAPQueryBuilder ，进行定制化查询。
flowable.idm.ldap.query.user-by-full-name-like	ldap.query.userbyname	-	通过全名查询用户所用的语句。 比如：(&(objectClass=inetOrgPerson)(|({0}=**{1}**)({2}={3}))) 返回LDAP中所有inetOrgPerson类、姓或名匹配的对象。 注入到表达式中的值：{0} : 名字属性名 {1} : 查询文本 {2} : 姓属性名 {3} : 查询文本 如果不能通过简单的语句进行查询，可以改用 org.flowable.ldap.LDAPQueryBuilder，进行定制化查询。
flowable.idm.ldap.query.user-by-id	ldap.query.userbyid	-	通过ID查询用户所用的语句。 比如：(&(objectClass=inetOrgPerson)(uid={0})) 返回LDAP中所有inetOrgPerson类、uid属性值匹配的对象。 上例中，使用{@link java.text.MessageFormat}即{0}注入用户ID。 如果不能通过简单的语句进行查询，可以改用 org.flowable.ldap.LDAPQueryBuilder ，进行定制化查询。
flowable.mail.server.host	email.host	localhost	邮件服务器地址。
flowable.mail.server.password	email.password	-	邮件服务器的密码。
flowable.mail.server.port	email.port	1025	邮件服务器的端口号。
flowable.mail.server.use-ssl	email.use-ssl	false	是否需要为SMTP协议启用SSL/TLS加密（即SMTPS/POPS）。
flowable.mail.server.use-tls	email.use-tls	false	是否启用STARTTLS加密。
flowable.mail.server.username	email.username	-	邮件服务器的用户名。 为空则不进行认证。
flowable.process.definition-cache-limit	flowable.process-definitions.cache.max	-1	流程定义缓存的最大数量。 默认值为-1，即缓存所有流程定义。

Table 5. 由Spring Boot管理的旧参数

参数名	原参数	默认值	描述
spring.datasource.driver-class-name	datasource.driver	-	JDBC驱动的全限定名。默认通过URL自动检测。
spring.datasource.jndi-name	datasource.jndi.name	-	数据源的JNDI。若设置JNDI，则忽略Class、url、username及password设置。
spring.datasource.password	datasource.password	-	数据库的登录密码。
spring.datasource.url	datasource.url	-	数据库的JDBC URL。
spring.datasource.username	datasource.username	-	数据库的登录用户名
spring.datasource.hikari.connection-test-query	datasource.preferred-test-query	-	用于验证连接的SQL语句。
spring.datasource.hikari.connection-timeout	datasource.connection.timeout	-	客户端等待获取连接的最大时间，以毫秒计。如果获取连接超时，会抛出SQLException。
spring.datasource.hikari.idle-timeout	datasource.connection.idletimeout	-	连接池中连接的最大空闲时间，以毫秒计。 实际销毁连接前，会多等平均+15秒，最大+30秒的额外时间。 不会在空闲超时前销毁连接。 值为0代表连接池不会销毁空闲连接。
spring.datasource.hikari.max-lifetime	datasource.connection.maxlifetime	-	连接池中连接的最大存活时间。如果连接超过存活时间，即使该连接刚被使用过，也会被连接池销毁。不会销毁正在使用的连接，只会销毁空闲的连接。
spring.datasource.hikari.maximum-pool-size	datasource.connection.maxpoolsize	-	连接池的最大容量，包括空闲及使用中的连接。这个配置决定了到数据库的实际连接数。如果连接池尺寸到达上限，且没有可用的空闲连接，则getConnection()会等待connectionTimeout设置的时间，然后超时。
spring.datasource.hikari.minimum-idle	datasource.connection.minidle	-	HikariCP连接池保留的最小空闲连接数量。如果空闲连接数量少于设置，HikariCP会尽最大努力尽快有效地恢复。
spring.servlet.multipart.max-file-size	file.upload.max.size	10MB	文件的最大尺寸，可以使用“MB”或“KB”后缀。

Table 6. 不再使用的旧参数

旧参数	描述
datasource.jndi.resource-ref	Spring Boot不支持配置JNDI resourceRef，而是按名称直接引用。
email.use-credentials	如果邮件服务器不使用认证，直接将用户名及密码置空即可。