Appendix B: 应用程序属性

Appendix B: 应用程序属性

本附录章节按字母顺序介绍所有可用的应用程序属性。

cuba.additionalStores

定义应用中使用的额外数据存储的名称。

在所有标准的 blocks 中都可以使用。

示例：

cuba.additionalStores = db1, mem1

cuba.allowQueryFromSelected: 启用通用过滤器的级联过滤模式。参考级联查询（Sequential Queries）。

默认值： true

保存在数据库。

配置接口： GlobalConfig

可以在 Web 客户端和 Middleware 这两个 block 使用。

cuba.anonymousLogin: 用来创建匿名用户会话的用户名称。（参考 cuba.anonymousSessionId）。

默认值： anonymous

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.anonymousSessionId: 定义匿名用户会话的 UUID，此会话可以在没有用户登录的状态下使用。在服务启动的时候，会自动创建这个匿名会话。参考 cuba.anonymousLogin。

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.automaticDatabaseUpdate: 定义服务器是否在应用程序启动时运行数据库更新脚本。

默认值： false

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.availableLocales

支持的用户界面语言列表。

属性格式： {language_name1}|{language_code_1};{language_name2}|{language_code_2};…

示例：

cuba.availableLocales=French|fr;English|en

{language_name} – 显示在可用语言列表中的语言名称。比如这个列表会被用在登录界面提供给用户选择系统语言，也在用户编辑界面，编辑用户的语言。

{language_code} – 对应于 Locale.getLanguage() 方法返回的语言代码。用来作为语言包文件名称的后缀，比如，messages_fr.properties。

如果语言列表中没有跟用户操作系统语言相匹配的条目，那么 cuba.availableLocales 属性定义的语言列表的第一个语言将被用来作为默认语言。否则，即会选择跟用户操作系统语言相匹配的做为默认语言。

默认值： English|en;Russian|ru;French|fr

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.backgroundWorker.maxActiveTasksCount: 活跃的后台任务的最大值。

默认值： 100

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.backgroundWorker.timeoutCheckInterval: 定义检查后台任务超时的间隔，单位是毫秒。

默认值： 5000

配置接口： ClientConfig

可以在 web 客户端使用。

cuba.bruteForceProtection.enabled: 启用针对野蛮破解密码的保护措施。

默认值： false

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.bruteForceProtection.blockIntervalSec: 超过最大失败登录尝试次数之后屏蔽登录的时间间隔，单位是秒，需要先启用 cuba.bruteForceProtection.enabled。

默认值： 60

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.bruteForceProtection.maxLoginAttemptsNumber: 针对用户名和登录 IP 设定的最大失败登录尝试次数，需要先启用 cuba.bruteForceProtection.enabled。

默认值： 5

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.checkPasswordOnClient: 当设置为 false（默认值）时，客户端块 block 的 LoginPasswordLoginProvider 将用户密码明文发送给中间件的 AuthenticationService.login() 方法。在客户端和中间件 block 共同位于同一 JVM 中的情况下，这是合适的处理方式。对于客户端块(block)位于网络上的其它计算机上的分布式部署的情况，客户端和中间件之间的连接应使用 SSL 加密。

如果设置为 true，LoginPasswordLoginProvider本身将通过输入的登录名加载User 实体并检查密码。如果密码与加载的密码哈希匹配，则提供程序使用cuba.trustedClientPassword 属性中指定的密码作为可信客户端执行登录。此模式使您无需在受信任网络中的客户端和中间件之间设置 SSL 连接，同时不会向网络公开用户密码：仅传输哈希值。但请注意，可信客户端密码仍然通过网络传输，因此受 SSL 保护的连接仍然更加安全。

默认值： false

接口： WebAuthConfig, PortalConfig, RestApiConfig

可在 Web 和 Porta block 使用。

cuba.cluster.enabled: 启用 Middleware 服务集群中各个服务之间的互相交互。参考配置多个 Middleware 服务交互。

默认值： false

可以在 Middleware block 使用。

cuba.cluster.jgroupsConfig

JGroups 配置文件的路径。平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

示例：

cuba.cluster.jgroupsConfig = my_jgroups_tcp.xml

默认值： jgroups.xml

可以在 Middleware block 使用。

cuba.cluster.messageSendingQueueCapacity: 限制 Middleware 集群中消息队列的长度。当消息队列超过了最大长度，新消息会被拒绝。

默认值： Integer.MAX_VALUE

可以在 Middleware block 使用。

cuba.cluster.stateTransferTimeout: 设置节点启动时从集群接收最新状态的超时时间。单位是毫秒。

默认值： 10000

可以在 Middleware block 使用。

cuba.confDir: 为应用程序 block 设置配置文件目录的位置。

对于 Tomcat 快速部署，默认值：${catalina.home}/conf/${cuba.webContextName}，指向 tomcat/conf 目录下 web app 名称的目录，比如 tomcat/conf/app-core。

对于 WAR 和 UberJAR 部署情况：${app.home}/${cuba.webContextName}/conf，指向应用程序根目录下的一个目录。

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.connectionReadTimeout: 在客户端 block 设置连接 Middleware 读取超时的时限。平台会将非负值传递给 URLConnection 的 setReadTimeout() 方法。

也可参考 cuba.connectionTimeout。

默认值： -1

可以在 Web 客户端，Web Portal blocks 使用。

cuba.connectionTimeout: 在客户端 block 设置连接 Middleware 超时的时限。平台会将非负值传递给 URLConnection 的 setConnectTimeout() 方法。

也可参考 cuba.connectionReadTimeout。

默认值： -1

可以在 Web 客户端，Web Portal blcoks 使用。

cuba.connectionUrlList

为客户端 blocks 设置连接 Middleware 服务的 URL。

此属性的值应该包含多个用英文逗号分隔 URL http[s]://host[:port]/app-core，host 是服务器名称，port 是服务器端口，app-core 是 Middleware web app 的名称。比如：

cuba.connectionUrlList = http://localhost:8080/app-core

当使用 Middleware 服务集群的时候，这些服务的地址需要用英文逗号分隔：

cuba.connectionUrlList = http://server1:8080/app-core,http://server2:8080/app-core

细节参考配置连接 Middleware 集群。

也可参考 cuba.useLocalServiceInvocation。

配置接口： ClientConfig

可以在 Web 客户端，Web Portal blcoks 使用。

cuba.creditsConfig

累加属性定义 credits.xml 文件。此文件包含应用程序使用的软件组件信息

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

可以在 Web 客户端 block 使用。

示例：

cuba.creditsConfig = +com/company/base/credits.xml

cuba.crossDataStoreReferenceLoadingBatchSize: DataManager 从不同数据存储批量加载关联实体的最大值。

默认值： 50

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.dataManagerChecksSecurityOnMiddleware: 配置在 Middleware 调用 DataManager 时是否启用安全限制。

默认值： false

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.dataSourceJndiName: 定义应用数据库连接中使用的 javax.sql.DataSource 的 JNDI 名称。

默认值： java:comp/env/jdbc/CubaDS

可以在 Middleware block 使用。

cuba.dataDir: 为应用程序 block 设置工作目录的位置。

对于 Tomcat 快速部署，默认值：${catalina.home}/work/${cuba.webContextName}，指向 tomcat/work 目录下 web app 名称的目录，比如 tomcat/work/app-core。

对于 WAR 和 UberJAR 部署情况：${app.home}/${cuba.webContextName}/work，指向应用程序根目录下的一个目录。

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.dbDir: 设置数据库脚本目录的位置。

对于 Tomcat 快速部署，默认值：${catalina.home}/webapps/${cuba.webContextName}/WEB-INF/db，指向 Tomcat 中 web app 的 WEB-INF/db 子目录。

对于 WAR 和 UberJAR 部署情况：web-inf:db，指向 WAR 或者 UberJAR 内的 WEB-INF/db 目录。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.dbmsType: 定义 DBMS 类型。跟 cuba.dbmsVersion 一起作用，影响对于 DBMS 集成接口实现的选取，以及查找数据库初始化和更新脚本。

参考 DBMS 类型了解细节。

默认值： hsql

可以在 Middleware block 使用。

cuba.dbmsVersion: 可选属性，设置数据库版本。跟 cuba.dbmsType 一起作用，影响对于 DBMS 集成接口实现的选取，以及查找数据库初始化和更新脚本。

参考 DBMS 类型了解细节。

默认值： none

可以在 Middleware block 使用。

cuba.defaultPermissionValuesConfig

定义包含用户默认权限的一组文件。当没有为许可对象设置角色的时候，会使用默认权限值。通常用来为“拒绝”角色使用，参考 default-permission-values.xml 章节了解更多信息。

默认值： cuba-default-permission-values.xml

可以在 Middleware block 使用。

示例：

cuba.defaultPermissionValuesConfig = +my-default-permission-values.xml

cuba.defaultQueryTimeoutSec: 设置默认的数据库事务超时时限.

默认值： 0 (no timeout).

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.disableEscapingLikeForDataStores: 定义一组数据存储，对于这些数据存储，平台会在 filters 中对使用了 LIKE 操作符的 JPQL 查询禁用转义。

保存在数据库。

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.disableOrmXmlGeneration: 对扩展实体，禁用自动生成 orm.xml 文件的功能。

默认值： false（如果存在扩展实体，则会自动创建 orm.xml）。

可以在 Middleware block 使用。

cuba.dispatcherSpringContextConfig

累加属性，为客户端 block 定义 dispatcher-spring.xml 文件。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

可以在 Web 客户端和 Web Portal blocks 使用。

示例：

cuba.dispatcherSpringContextConfig = +com/company/sample/portal-dispatcher-spring.xml

cuba.download.directories: 定义一组文件目录，Middleware 可以从这些文件目录通过 com.haulmont.cuba.core.controllers.FileDownloadController 下载文件。比如，web 客户端系统菜单的 Administration > Server Log 就是利用这个机制下载 log 文件进行展示。

目录列表需要使用英文分号分隔。

默认值： ${cuba.tempDir};${cuba.logDir} (可以从临时文件夹 and the 日志文件夹目录下载文件)。

可以在 Middleware block 使用。

cuba.email.*: 在配置电子邮件发送参数有关于发送邮件参数的介绍。

cuba.fileStorageDir: 定义文件存储目录结构的根目录。更多信息，参考标准文件存储实现。

默认值： null

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.enableDeleteStatementInSoftDeleteMode: 向后兼容的开关。如果设置为 true，在软删除模式开启的情况下，开启为软删除的实体执行 delete from 的 JPQL 语句（软删除开启的情况，对实体只是运行 update 而非 delete）。这样的 delete 语句会被转换成删除所有没有标记为“已删除”的数据。这样的话，有点违反直观理解，所以默认情况下是关闭此功能的。

默认值： false

可以在 Middleware block 使用。

cuba.enableSessionParamsInQueryFilter: 向后兼容的开关。如果设置为 false，在数据源查询过滤器和界面过滤器组件的过滤条件会被应用一次，至少会使用一个参数；会话（session）参数不会起作用。

默认值： true

可以在 web 客户端 block 使用。

cuba.entityAttributePermissionChecking: 如果设置为 true，在 Middleware 开启实体属性权限检查。如果设置为 false，属性权限检查则在客户端层做，比如在 Generic UI 或者 REST API。

默认值： false

保存在数据库。

可以在 Middleware block 使用。

cuba.entityLog.enabled: 开启实体日志机制。

默认值： true

保存在数据库。

配置接口： EntityLogConfig

可以在 Middleware block 使用。

cuba.groovyEvaluationPoolMaxIdle: 在执行 Scripting.evaluateGroovy() 方法的过程中，设置资源池中未使用的编译过的 Groovy 表达式的最大值。当需要集中执行 Groovy 表达式的时候，推荐将这个值设置得大一些，比如，按照应用程序目录的数量来设置。

默认值： 8

在所有标准的 blocks 中都可以使用。

cuba.groovyEvaluatorImport

在执行脚本的时候，定义一组需要被所有 Groovy 表达式引入的类。

列表中的类名需要使用英文逗号或者分号分隔。

默认值： com.haulmont.cuba.core.global.PersistenceHelper

在所有标准的 blocks 中都可以使用。

示例：

cuba.groovyEvaluatorImport = com.haulmont.cuba.core.global.PersistenceHelper,com.abc.sales.CommonUtils

cuba.gui.genericFilterChecking: 影响的过滤器组件行为。

当设置为 true，不允许执行不指定参数的过滤器。

默认值： false

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.genericFilterColumnsCount: 为过滤器组件定义含有过滤条件的列的数量。

默认值： 3

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.genericFilterConditionsLocation: 定义在过滤器组件中条件面板的位置。两种位置可以选择：top（在过滤器控制器元素之上）和 bottom（在过滤器控制器元素之下）。

默认值： top

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.genericFilterControlsLayout

为过滤器组件的控制器布局设置模板。每个控制器有这样的格式：[component_name | options-comma-separated]，比如，[pin | no-caption, no-icon]。

可用的控制器：

-
filters_popup - 选择过滤器的弹窗按钮，整合了 Search 按钮功能。

-
filters_lookup - 选择过滤器的查找字段。需要单独添加 Search 按钮。

-
search - Search 按钮。如果使用 filters_popup 则不需要添加。

-
add_condition - 添加新条件的按钮。

-
spacer - 控制器之间空白的分隔符。

-
settings - Settings 按钮。设置在 Settings 弹窗中显示的 action 选项的名称。（参考下面）。

-
max_results - 控制器组，用来设置选择记录的最大值。

-
fts_switch - 用来切换到全文检索（Full-Text Search）模式的复选框。

以下这些操作可以在 settings 中作为选项使用：save - 保存, save_as - 另存为, edit - 编辑, remove - 删除, pin - 固定位置, make_default - 设置默认, save_search_folder - 保存搜索目录, save_app_folder - 保存应用目录, clear_values - 清空。

这些操作也可以在 Settings 弹窗外作为单独的控制器使用。这种情况下，它们可以做如下设置：

-
no-icon - 设置动作按钮是否不带图标，示例： [save | no-icon]。

-
no-caption - 设置动作按钮是否不带名称，示例： [pin | no-caption]。

默认值：

[filters_popup] [add_condition] [spacer] \
[settings | save, save_as, edit, remove, make_default, pin, save_search_folder, save_app_folder, clear_values] \
[max_results] [fts_switch]

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.genericFilterManualApplyRequired: 影响过滤器组件的行为。

当设置为 true，包含过滤器的界面不会自动加载相应的数据源，需要用户手动点击过滤器的 Apply 按钮。

当使用应用或者查找目录打开界面的时候，cuba.gui.genericFilterManualApplyRequired 的设置会被忽略，因为此时过滤器已经生效了。但是对于某个查找目录如果它的 applyDefault 设置为 false，过滤器不会生效。

默认值： false

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.genericFilterMaxResultsOptions: 定义过滤器组件中 Show rows 下拉框中的选项值。

NULL 选项表示这个列表需要包含一个空值。

默认值： NULL, 20, 50, 100, 500, 1000, 5000

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.genericFilterPopupListSize: 定义在 Search 按钮的弹窗列表中显示项目的数量。如果过滤器的数量超过了这个值，则会添加 Show more… 到列表最后，这个行为会打开一个新的弹窗用来显示其它的过滤器。

默认值： 10

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.genericFilterTrimParamValues: 定义所有的通用过滤器是否需要去掉输入值两端的空格。当设置为 false，文本过滤器将保留空格。

默认值： true

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.layoutAnalyzerEnabled: 可以禁用主窗口标签页以及模式窗口标题的右键菜单中的界面分析器。

默认值： true

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.lookupFieldPageLength: 定义在下拉框控件和下拉框选择器控件中下拉列表一页显示的选项默认数量。可以通过 XML 属性 pageLength 在具体实例中覆盖这个参数的设置。

默认值： 10

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端使用。

cuba.gui.manualScreenSettingsSaving: 如果此属性设置为 true，界面不会在关闭时自动保存界面设置。在这个模式下，用户可以通过右键点击界面 tab 标签或者弹窗的标题类保存或者重置界面设置。

默认值： false

配置接口： ClientConfig

保存在数据库。

可以在 Web 客户端 block 使用。

cuba.gui.showIconsForPopupMenuActions: 启用在 Table 右键菜单和 PopupButton 中显示动作的图标。

默认值： false

保存在数据库。

配置接口： ClientConfig

可以在 web 客户端 block 使用。

cuba.gui.systemInfoScriptsEnabled: 启用在 System Information 窗口创建/更新/获取实体实例的时候显示 SQL 脚本。

这些脚本实际上显示的选中实体实例的数据库行内容，而不管是否有安全设置可能禁止显示某些实体属性。所以这就是为什么除了 administrator 用户之外需要取消其它所有用户角色的 CUBA / Generic UI / System Information 特殊权限。也可以通过设置 cuba.gui.systemInfoScriptsEnabled 为 false 在整个应用级别禁止这个功能。

默认值： true

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.useSaveConfirmation: 当用户关闭带有未保存改动数据源的界面时，定义对话框的布局样式。

true 对应带有三个功能的布局：Save changes - 保存修改, Don’t Save - 不保存修改, Don’t close the screen - 不关窗口。

false 对应带有两个功能的布局：Close the screen without saving changes - 关闭窗口不保存修改, Don’t close the screen - 不关窗口。

默认值： true

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.gui.validationNotificationType: 定义标准的界面验证错误的通知消息类型。

可选值是 com.haulmont.cuba.gui.components.Frame.NotificationType 枚举类型的元素：

-
TRAY - 右下角的通知消息，带有普通消息文本。

-
TRAY_HTML - 右下角的通知消息，带有 HTML 消息文本。

-
HUMANIZED - 标准通知消息，显示在界面中间，带有普通消息文本。

-
HUMANIZED_HTML - 标准通知消息，显示在界面中间，带有 HTML 消息文本。

-
WARNING - 警告通知消息，显示在界面中间，带有普通消息文本，点击时消失。

-
WARNING_HTML - 警告通知消息，显示在界面中间，带有 HTML 消息文本，点击时消失。

-
ERROR - 错误通知消息，显示在界面中间，带有普通消息文本，点击时消失。

-
ERROR_HTML - 错误通知消息，显示在界面中间，带有 HTML 消息文本，点击时消失。

默认值： TRAY.

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.hasMultipleTableConstraintDependency: 针对实体组合采用 JOINED 的继承策略。如果设置为 true，为在数据库插入新实体提供正确的顺序。

默认值： false

cuba.healthCheckResponse: 定义从应用健康检查 URL 请求返回的文本。

默认值： ok

配置接口： GlobalConfig

可以用在所有 blocks。

cuba.httpSessionExpirationTimeoutSec

定义 HTTP 会话非活动状态的超时时限，单位为秒

默认值： 1800

配置接口： WebConfig

可以在 web 客户端 block 使用。

推荐对于 cuba.userSessionExpirationTimeoutSec 和 cuba.httpSessionExpirationTimeoutSec 属性使用相同的值。

cuba.iconsConfig

累加属性用来定义图标集合.

可以在 Web 客户端 block 使用。

示例：

cuba.iconsConfig = +com.company.demo.web.MyIconSet

cuba.inMemoryDistinct: 启用基于内存的重复记录过滤，而不使用数据库级别的 select distinct。用在 DataManager 中。

默认值： false

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.jmxUserLogin: 定义可以用在系统认证的用户名。

默认值： admin

可以在 Middleware block 使用。

cuba.keyForSecurityTokenEncryption: 作为实体安全令牌（security token）AES 加密的密钥。当实体通过下面方式在 Middleware 加载的时候，这个令牌会放置在实体实例内发送：

-
cuba.entityAttributePermissionChecking 应用程序属性设置成 true，也就是说在 Middleware 对实体属性权限进行了加强。（参考 DataManager 安全机制了解详情）

-
行级的安全限制过滤了集合一组属性中的部分元素。这种情况下，安全令牌也会包含在 REST API 的返回 JSON 中，参考集合属性的安全约束。

-
实体设置了动态属性访问控制。

尽管安全令牌不包含任何属性值（只有属性名称和过滤了的实体标识符），仍然高度建议在生产环境中修改默认的加密密钥值。

默认值： CUBA.Platform

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.numberIdCacheSize

当继承了 BaseLongIdEntity 或者 BaseIntegerIdEntity 的实体实例通过 Metadata.create() 方法在内存创建的时候，会给创建的实体分配一个唯一标识符。这个值通过从数据序列取下一个值的机制得到的。为了减少对 Middleware 和数据库调用的次数，序列每次的增加值默认是设置的 100，也就是说平台每次从数据库调用一次能获取 100 个 id。也就是说按照这种方式“缓存”了序列值，直到 100 个 id 用完之前都可以直接从内存获取 id。

这个属性定义了每次序列自增的值，以及对应的内存中缓存的大小。

如果在数据库已经有部分实体存在的情况下需要修改这个属性的值，此时会重新创建所有已经存在的序列：用新的自增值（必须等于 cuba.numberIdCacheSize），起始值是目前已经存在 id 的最大值。

别忘了在应用的所有 block 都设置这个属性。比如，如果有 Web 客户端，Portal 客户端和 Middleware，需要在 web-app.properties, portal-app.properties 和 app.properties 中将这个属性设置成相同的值。

默认值： 100

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.legacyPasswordEncryptionModule: 与cuba.passwordEncryptionModule 相同，但这个配置是用于为在旧版本中（版本 7 之前）创建并且 SEC_USER.PASSWORD_ENCRYPTION 字段为空的用户定义用于用户密码哈希的 bean 的名称。

默认值： cuba_Sha1EncryptionModule

用于所有所标准 block。

cuba.localeSelectVisible: 登录时禁用用户界面语言选择。

如果 cuba.localeSelectVisible 设置成 false，用户会话的 locale 会按照下面方式选择：

-
如果 User 实例定义了 language 属性，系统会使用这个属性定义的语言。

-
如果用户的操作系统语言在可选的区域列表里（通过 cuba.availableLocales 设置），系统会使用这个语言。

-
其它情况下，系统会使用定义在 cuba.availableLocales 属性中的第一个语言。

默认值： true

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.logDir: 为应用程序 block 设置日志目录的位置。

对于 Tomcat 快速部署，默认值：${catalina.home}/logs，指向 tomcat/logs 目录。

对于 WAR 和 UberJAR 部署情况：${app.home}/logs，指向应用程序根目录下的 logs 目录。

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.mainMessagePack

累加属性，为一个 block 定义主语言包。

属性值可以包含单一语言包，或者用空格分隔的语言包列表。

在所有标准的 blocks 中都可以使用。

示例：

cuba.mainMessagePack = +com.company.sample.gui com.company.sample.web

cuba.maxUploadSizeMb: 定义可以使用文件上传控件和多个文件上传控件组件能上传的文件大小的最大值，单位是 MB。

默认值： 20

保存在数据库。

配置接口： ClientConfig

可以在 Web 客户端 block 使用。

cuba.menuConfig

累加属性，定义 menu.xml 文件。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

可以在 Web 客户端 block 使用。

示例：

cuba.menuConfig = +com/company/sample/web-menu.xml

cuba.metadataConfig

累加属性，定义 metadata.xml 文件。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

在所有标准的 blocks 中都可以使用。

示例：

cuba.metadataConfig = +com/company/sample/metadata.xml

cuba.passwordEncryptionModule: 定义用作用户密码 Hash 的 bean 名称。创建新用户或更新用户密码时，将在 SEC_USER.PASSWORD_ENCRYPTION 数据库字段中为该用户存储此属性的值。

参阅 cuba.legacyPasswordEncryptionModule。

默认值：cuba_BCryptEncryptionModule

在所有标准的 blocks 中都可以使用。

cuba.passwordPolicyEnabled: 启用强制密码策略。如果此属性设置为 true，所有新的用户密码都会按照 cuba.passwordPolicyRegExp 属性定义的策略检查。

默认值： false

保存在数据库。

配置接口： ClientConfig

使用在所有的客户端 blocks：web 客户端，web Portal。

cuba.passwordPolicyRegExp: 定义一个正则表达式，用来做密码检查策略。

默认值：

((?=.\d)(?=.\p{javaLowerCase}) (?=.*\p{javaUpperCase}).{6,20})

上面这个表达式确保密码需要包含 6～20 个字符，使用数字和英文字母，包含至少一个数字，一个小写字母，一个大写字母。更多关于正则表达式语法可以参考 https://en.wikipedia.org/wiki/Regular_expression 和 http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html 。

保存在数据库。

配置接口： ClientConfig

使用在所有的客户端 blocks：web 客户端，web Portal。

cuba.performanceLogDisabled: 如果需要禁用 PerformanceLogInterceptor，此参数必须要设置为 true。

PerformanceLogInterceptor 通过类或者方法的 @PerformanceLog 注解触发，此拦截器会在 perfstat.log 文件中记录每次方法的调用记录以及执行时间。如果不需要这些日志，建议禁用 PerformanceLogInterceptor 以提高性能。如需重新启用，删除此参数或者设置为 false。

默认值： false

可以在 Middleware block 使用。

cuba.performanceTestMode: 应用程序在做性能测试的时候必须设置成 true。

配置接口： GlobalConfig

默认值： false

可以用在 Middleware 和 web 客户端。

cuba.permissionConfig

累加属性，用来定义 permissions.xml 文件。

可以在 Web 客户端 block 使用。

示例：

cuba.permissionConfig = +com/company/sample/web-permissions.xml

cuba.persistenceConfig

累加属性，用来定义 persistence.xml 文件。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

在所有标准的 blocks 中都可以使用。

示例：

cuba.persistenceConfig = +com/company/sample/persistence.xml

cuba.portal.anonymousUserLogin: 定义在 Web Portal block 可以做匿名用户会话的用户名称。

此属性设置的用户名需要在安全子弟痛存在，并且有需要的权限。不需要为此用户设置密码，因为匿名用户会话是通过 loginTrusted() 方法创建的，使用的是 cuba.trustedClientPassword 属性定义的密码。

配置接口： PortalConfig

可以在 Web Portal block 使用。

cuba.queryCache.enabled: 如果设置为 false，查询缓存功能禁用。

默认值： true

配置接口： QueryCacheConfig

可以在 Middleware block 使用。

cuba.queryCache.maxSize: 设置查询缓存实体数量的最大值。一条缓存记录是通过查询语句文本，查询语句参数，分页参数以及软删除配置确定。

由于缓存大小会慢慢增长到最大值，所以缓存机制会清除掉那些不大可能会被再次使用的记录。

默认值： 100

配置接口： QueryCacheConfig

可以在 Middleware block 使用。

cuba.remotingSpringContextConfig

累加属性，用来定义 Middleware block 的 remoting-spring.xml 文件。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

可以在 Middleware block 使用。

示例：

cuba.remotingSpringContextConfig = +com/company/sample/remoting-spring.xml

cuba.rest.allowedOrigins: 定义英文逗号分隔的可以访问 REST API 的来源。需要开启跨域访问时可以用这个参数。

默认值： *

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.anonymousEnabled: 对匿名用户启用 REST API 访问。

默认值： false

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.client.authorizedGrantTypes: 为默认的 REST API 客户端定义支持的许可类型列表。需要禁用刷新令牌（refresh token），可以从列表中删除 refresh_token。

默认值： password,external,refresh_token

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.client.id: 定义 REST API 客户端的标识符。客户端，在这里，并不是说平台的用户，而是一个使用 REST API 的应用（某些 web portal 或者手机 app）。使用客户端用户名密码做访问 REST API token 端点的基本认证。

默认值： client

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.client.secret: 定义 REST API 客户端的密码。客户端，在这里，并不是说平台的用户，而是一个使用 REST API 的应用（某些 web portal 或者手机 app）。使用客户端用户名密码做访问 REST API token 端点的基本认证。

默认值： secret

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.client.tokenExpirationTimeSec: 定义默认客户端 REST API 访问令牌过期时间的时限，单位是秒。

默认值： 43200 (12 小时)

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.client.refreshTokenExpirationTimeSec: 定义默认客户端 REST API 刷新令牌过期时间的时限，单位是秒。

默认值： 31536000 (365 天)

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.deleteExpiredTokensCron: 指定用来做定时任务的表达式，从数据库删除过期的令牌。

默认值： 0 0 3 ?

可以在 Middleware block 使用。

cuba.rest.jsonTransformationConfig

累加属性，用来定义 REST API 使用的 JSON 转换配置文件，这些文件在客户端请求一些特殊版本数据模型的信息时会用到。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

文件的 XSD schema： http://schemas.haulmont.com/cuba/7.0/rest-json-transformations.xsd.

默认值： none

示例：

cuba.rest.jsonTransformationConfig = +com/company/sample/json-transformations.xml

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.maxUploadSize: 可以使用 REST API 上传的文件大小的最大值，单位是字节。

默认值： 20971520 (20 Mb)

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.optimisticLockingEnabled: 如果在 JSON 中提供了实体的 version 属性，启用 Versioned 实体的乐观锁。

默认值： false

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.requiresSecurityToken: 如果是 true，会在加载的实体中包含一个特殊的系统属性，并且需要在保存实体的时候给 REST 接口传回一个同样的属性。细节参考集合属性的安全约束。

默认值： false

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.reuseRefreshToken: 定义是否可以重复使用刷新令牌。如果设置为 false，当使用刷新令牌获取访问令牌的时候，系统会发出一个新的刷新令牌，老的刷新令牌将会失效。

默认值： true

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.servicesConfig

累加属性，用来定义包含应用 REST API 对应的 services 列表的文件。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

文件的 XSD schema： http://schemas.haulmont.com/cuba/7.0/rest-services-v2.xsd.

默认值： none

示例：

cuba.rest.servicesConfig = +com/company/sample/app-rest-services.xml

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.storeTokensInDb: 启用在数据库保存 REST API 安全令牌。默认情况下，令牌只是在内存中存储。

保存在数据库。

配置接口： ServerConfig

默认值： false

可以在 Middleware block 使用。

cuba.rest.tokenMaskingEnabled: 设置是否在应用程序日志中对 REST API 进行掩码处理。

默认值： true

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.rest.queriesConfig

累加属性，用来定义包含应用程序 REST API 可用的 JPQL 查询列表的文件。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

文件的 XSD schema： http://schemas.haulmont.com/cuba/7.0/rest-queries.xsd.

默认值： none

示例：

cuba.rest.queriesConfig = +com/company/sample/app-rest-queries.xml

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.schedulingActive: 启用 CUBA 计划任务机制。

默认值： false

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.serialization.impl: 指定 Serialization 接口的实现类，用来在应用程序 blocks 之间做对象传递时做序列化。平台包含两个实现类：

-
com.haulmont.cuba.core.sys.serialization.StandardSerialization - 标准 Java 序列化。

-
com.haulmont.cuba.core.sys.serialization.KryoSerialization - 基于 Kryo 框架的序列化实现。

默认值： com.haulmont.cuba.core.sys.serialization.StandardSerialization

在所有标准的 blocks 中都可以使用。

cuba.springContextConfig

累加属性，用来为各个 block 定义 spring.xml 文件。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

在所有标准的 blocks 中都可以使用。

示例：

cuba.springContextConfig = +com/company/sample/spring.xml

cuba.supportEmail: 定义一个 email 地址。从默认异常处理界面发送的异常报告，从 Help > Feedback 界面发送的用户消息都会被发送到这个地址。

如果这个属性没有设置，系统会隐藏异常处理界面的 Report 按钮。

为了成功的发送邮件，配置电子邮件发送参数中描述的参数也必须设置。

默认值： empty string.

保存在数据库。

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.tempDir: 为应用程序 block 设置临时目录的位置。

对于 Tomcat 快速部署，默认值：${catalina.home}/temp/${cuba.webContextName}，指向 tomcat/temp 目录下 web app 名称的目录，比如 tomcat/temp/app-core。

对于 WAR 和 UberJAR 部署情况：${app.home}/${cuba.webContextName}/temp，指向应用程序根目录下的一个目录。

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.testMode: 如果在运行自动化用户界面测试，这个属性必须设置成 true。

配置接口： GlobalConfig

默认值： false

可以用在 Web 客户端和 Middleware blcoks。

cuba.themeConfig: 定义一组 *-theme.properties 文件，存储 theme 变量，比如默认的对话框范围以及文本输入框的宽度。

这个属性的值是一组用空格分隔的文件列表，文件通过使用 Resource - 资源接口来加载。

Web 客户端的默认值： com/haulmont/cuba/havana-theme.properties com/haulmont/cuba/halo-theme.properties com/haulmont/cuba/hover-theme.properties

可以在 Web 客户端使用。

cuba.triggerFilesCheck: 启用对 bean 调用触发器文件的处理。

触发器文件是放在应用程序 block 的临时文件夹的 triggers 子目录。触发器文件命名是包含使用“点“分隔的两部分。前半部分是 bean 名称，后半部分是 bean 中需要调用的方法名称。示例： cuba_Messages.clearCache。触发器文件处理器会监控这个目录是否有新文件，如果有的话，会调用指定的方法，然后删除这些文件。

默认情况下，触发器文件的处理是配置在 cuba-web-spring.xml 文件中，并且只在 Web 客户端配置。在项目级别，其它模块的处理可以通过周期性的调用 cuba_TriggerFilesProcessor bean 的 process() 方法来做。

默认值： true

可以在配置了需要处理的 blocks 中使用，默认是 web 客户端。

cuba.triggerFilesCheckInterval: 定义检查触发器文件的时间间隔，需要开启 cuba.triggerFilesCheck 参数。单位是毫秒。

默认值： 5000

可以在配置了需要处理的 blocks 中使用，默认是 web 客户端。

cuba.trustedClientPassword: 定义 LoginService.loginTrusted() 方法要使用的密码。Middleware 层可以使用这个密码而不是用户密码来做用户认证，这些用户通过信任的客户端 block 连接。

这个属性在用户的密码不存在数据库的时候使用，客户端 block 会自己做实际的认证。比如，集成 Active Directory 的时候。

配置接口： ServerConfig, WebAuthConfig, PortalConfig

可以使用的 blocks：Middleware，Web 客户端，Web Portal。

cuba.trustedClientPermittedIpList

定义一组 IP 地址，从这些地址可以调用 LoginService.loginTrusted() 方法。示例：

cuba.trustedClientPermittedIpList = 127.0.0.1, 10.17..

默认值： 127.0.0.1

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.uniqueConstraintViolationPattern

正则表达式，用来找出由于数据库违反唯一性约束造成的异常。约束的名称会从表达式的第一个非空组获得，示例：

ERROR: duplicate key value violates unique constraint "(.+)"

约束的名称可以用来显示本地化消息，以便找出是什么实体引起的。因此，需要在主语言包中包含为约束名定义的键值。示例：

IDX_SEC_USER_UNIQ_LOGIN = A user with the same login already exists

根据 DBMS locale 和版本的不同，这个属性还可以定义针对违反唯一性约束需要作出的响应。

当前 DBMS 的默认值通过 PersistenceManagerService.getUniqueConstraintViolationPattern() 方法返回。

可以定义在数据库。

可以在所有的客户端 blocks 使用。

cuba.useCurrentTxForConfigEntityLoad: 对于通过配置接口加载实体实例，如果当前已经有事务了，则使用当前事务加载。这个对性能有提高。否则，会创建一个新的连接，并且做提交，然后会返回游离（detached）的实体实例。

默认值： false

可以在 Middleware block 使用。

cuba.useEntityDataStoreForIdSequence: 如果此属性设置为 true，为 BaseLongIdEntity 和 BaseIntegerIdEntity 子类生成唯一标识符的序列会创建在相应实体存在的数据存储中。否则，这些序列存在主数据存储中。

默认值： false

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.useInnerJoinOnClause: EclipseLink ORM 会在 inner join 中使用 JOIN ON 从句，而不会在 WHERE 从句中使用条件语句。

默认值： false

可以在 Middleware block 使用。

cuba.useLocalServiceInvocation: 当设置为 true，Web 客户端和 Web Portal blocks 会在本地调用 Middleware 服务，避开网络堆栈，这样有利于系统性能。这个情况在 Tomcat 快速部署和单一 WAR 或者单一 UberJAR 部署的时候可以用到。对于其它的部署形式，这个值需要设置成 false。

默认值： false

可以在 Web 客户端和 Web Portal blocks 使用。

cuba.useReadOnlyTransactionForLoad: DataManager 中的所有 load 方法都会使用只读事务。

默认值： true

保存在数据库。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.user.fullNamePattern: 为用户定义显示全部名称的模式。

默认值： {FF| }{LL}

全名称模式可以用用户的姓，名，和中间名（外国人）来构成。模式需要按照下面的规则：

-
模式的各部分通过 {} 来分隔。

-
在 {} 内的部分必须包含一下列出的字符的一种，然后紧跟一个 |，没有空格：

LL – 用户姓的长格式 (Smith)

L – 用户姓的短格式 (S)

FF – 用户名的长格式 (John)

F – 用户名的短格式 (J)

MM – 用户中间名的长格式 (Paul)

M – 用户中间名的短格式 (P)

-
| 字符后面可以跟任何符号，也可以包含空格。

可以在 Web 客户端 block 使用。

cuba.user.namePattern: 为 User 实体定义显示名称模式。显示名称用在几个不同的地方，包括显示在系统主窗口右上角。

默认值： {1} [{0}]

{0} 会用 login 属性替换, {1} 会用 name 属性替换。

可以在 Middleware，Web 客户端 blocks 使用。

cuba.userSessionExpirationTimeoutSec

定义用户会话超时的时限。单位是秒。

默认值： 1800

配置接口： ServerConfig

可以在 Middleware block 使用。

建议为 cuba.userSessionExpirationTimeoutSec 和 cuba.httpSessionExpirationTimeoutSec 设置相同的值。

cuba.userSessionLogEnabled: 开启用户会话日志功能。

默认值： false

保存在数据库。

配置接口： GlobalConfig.

在所有标准的 blocks 中都可以使用。

cuba.userSessionProviderUrl: 定义 Middleware block 的 URL 来作为用户登录服务。

这个参数需要在额外的 middleware blcoks 中设置，这些 middleware 可以执行客户端请求，但是不分享用户会话缓存。如果在请求发起的时候，在本地的缓存中没有需要的会话，这个 block 会在指定的 URL 执行 LoginService.getSession() 方法，然后将取到的会话缓存到本地。

配置接口： ServerConfig

可以在 Middleware block 使用。

cuba.viewsConfig

累加属性，用来定义 views.xml 文件。参考视图。

平台使用 Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

在所有标准的 blocks 中都可以使用。

示例：

cuba.viewsConfig = +com/company/sample/views.xml

cuba.webAppUrl: 定义 web 客户端应用的 URL。

在特殊情况下，这个属性也用来生成外部应用程序的界面链接，也会被 ScreenHistorySupport 类使用。

默认值： http://localhost:8080/app

保存在数据库。

配置接口： GlobalConfig

在所有标准的 blocks 中都可以使用。

cuba.web.urlHandlingMode: 定义如何处理 URL 更改。

可选值为 UrlHandlingMode 枚举类型的元素：

-
NONE – 不会处理 URL 改动；

-
BACK_ONLY – 使用 CubaHistoryControl 来处理改动。这个值替换旧的cuba.web.allowHandleBrowserHistoryBack属性；

-
URL_ROUTES – 使用URL 历史及导航功能处理改动。

默认值： URL_ROUTES

配置接口： WebConfig

cuba.windowConfig

累加属性，用来定义 screens.xml 文件。

Resource - 资源接口来加载此文件，所以这个文件可以放在 classpath 或者配置文件目录。

可以在 Web 客户端 block 使用。

示例：

cuba.windowConfig = +com/company/sample/web-screens.xml

cuba.web.allowHandleBrowserHistoryBack: 如果登录界面和/或者主窗口实现了 CubaHistoryControl.HistoryBackHandler 接口的话，用此参数开启对于浏览器 Back - 返回 按钮的处理。如果此属性设置为 true，浏览器标准的行为会替换成调用接口的处理方法。

参考 Web 客户端基础设施。

默认值： true

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.appFoldersRefreshPeriodSec: 定义应用程序目录刷新时间间隔，单位是秒。

默认值： 180

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.appWindowMode: 定义主应用窗口的初始化模式 - “标签式”还是“单页式”（TABBED 或者 SINGLE）。在“单页式”模式下，当使用 NEW_TAB 参数打开界面时，新界面会完全替换现有界面而不是打开一个新的标签页。

用户之后可以在 Help > Settings 界面更改此模式。

默认值： TABBED

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.closeIdleHttpSessions: 当上一次非心跳请求之后，会话超时也已经过期，Web 客户端是否可以关闭 UI 和会话。

默认值： false

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.componentsConfig

累加属性，用来定义包含应用程序组件信息的配置文件，这些文件由不同的 Jar 包提供或者在 web 模块的 cuba-ui-component.xml 中描述。

示例：

cuba.web.componentsConfig =+demo-web-components.xml

cuba.web.customDeviceWidthForViewport: 自定义 HTML 页面的 viewport 宽度。影响 Vaadin HTML 页面上的 "viewport" 元标签(viewport meta tag)。

默认值： -1

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.defaultScreenCanBeClosed: 定义默认界面是否也可以通过关闭按钮、ESC 按钮或者标签页右键菜单（当使用 TABBED 工作区模式）进行关闭。

默认值： true

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.defaultScreenId

定义登录后默认打开的界面。这个设置对所有用户生效。

示例：

cuba.web.defaultScreenId = sys$SendingMessage.browse

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.externalAuthentication: Deprecated - 废弃. 使用 web 登录扩展点替代.

通过外部认证机制进行认证，比如 LDAP 或者 SSO IDP。也可参考cuba.web.externalAuthenticationProviderClass以及 IDP 插件 wiki 。

默认值： false

配置接口： WebAuthConfig

可以在 web 客户端 block 使用。

cuba.web.externalAuthenticationProviderClass: Deprecated - 废弃. 使用 web 登录扩展点替代.

实现了 CubaAuthProvider 接口的类，当 cuba.web.externalAuthentication 设置成 true 的时候会使用这个类做认证。

参考集成 LDAP 和 IDP 插件 wiki 了解更多示例。

配置接口： WebAuthConfig

可以在 web 客户端 block 使用。

cuba.web.foldersPaneDefaultWidth: 为文件夹面板设置默认的宽度，单位是像素。

默认值： 200

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.foldersPaneEnabled: 启用文件夹面板功能。

默认值： false

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.foldersPaneVisibleByDefault: 设置是否要默认展开文件夹面板。

默认值： false

配置接口： WebConfig

可以在 web 客户端 block 使用。

cuba.web.ldap.enabled

在 Web 客户端启用/禁用 LDAP 登录机制。

示例：

cuba.web.ldap.enabled = true