Приложение B. Свойства приложения

В данном приложении в алфавитном порядке описаны доступные свойства приложения.

cuba.allowQueryFromSelected

Разрешает универсальному фильтру использовать режим последовательного наложения фильтров. См. также Раздел 4.2.6.10.2, «Последовательная выборка»

Значение по умолчанию: true

Интерфейс: GlobalConfig

Используется в блоках Web Client и Middleware.

cuba.allowSetNotLoadedAttributes

Разрешает вызывать setter для незагруженных атрибутов Detached сущностей. Подробнее см. Раздел 4.2.3, «Представления»

Значение по умолчанию: false

Используется во всех блоках приложения.

cuba.automaticDatabaseUpdate

Включает режим выполнения скриптов БД сервером на старте приложения.

Значение по умолчанию: false

Интерфейс: ServerConfig

Используется в блоке Middleware.

cuba.availableLocales

Список поддерживаемых языков интерфейса.

Формат свойства: {название_языка1}|{код_языка_1};{название_языка2}|{код_языка_2};... Пример:

cuba.availableLocales=French|fr;English|en

{название_языка} − это название, которое будет отображаться в списках доступных языков. Например, в окне входа в систему, в экране редактирования пользователя.

{код_языка} − соответствует коду, возвращаемому методом Locale.getLanguage(). Используется как суффикс для формирования имен файлов пакетов сообщений. Например, messages_fr.properties.

Следует иметь в виду, что язык, который указан первым в списке языков свойства cuba.availableLocales, будет отображаться первым в списке доступных языков в том случае, если среди языков данного свойства не будет найден текущий язык операционной системы пользователя. Если же язык операционной системы присутствует в списке доступных, то отображаться первым будет он.

Значение по умолчанию: English|en;Russian|ru;French|fr

Интерфейс: GlobalConfig

Используется во всех стандартных блоках.

cuba.backgroundWorker.maxActiveTasksCount

Максимальное количество активных фоновых задач.

Значение по умолчанию: 100

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.backgroundWorker.maxClientLatencySeconds

Задержка в секундах, которая добавляется к таймауту фоновой задачи, прежде чем она будет прервана механизмом WatchDog. Отражает возможные сетевые задержки при опросе статуса задачи.

Значение по умолчанию: 60

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.backgroundWorker.uiCheckInterval

Период опроса состояния фоновых задач.

Значение по умолчанию: 2000

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.client.maxUploadSizeMb

Максимальный размер файла в мегабайтах, который может быть загружен с помощью компонентов FileUploadField и FileMultiUploadField.

Значение по умолчанию: 20

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.cluster.enabled

Включает взаимодействие серверов Middleware в кластере. Подробнее см. Раздел 6.3.2.2, «Настройка взаимодействия серверов Middleware».

Значение по умолчанию: false

Используется в блоке Middleware.

cuba.confDir

Конфигурационный параметр, задающий расположение каталога конфигурации данного блока приложения.

Значение по умолчанию для блоков Middleware, Web Client, Web Portal: ${catalina.home}/conf/${cuba.webContextName}, что в случае стандартного развертывания в Tomcat означает расположение внутри каталога tomcat/conf в подкаталоге с именем текущего веб-приложения, например, tomcat/conf/app-core.

Значение по умолчанию для блока Desktop Client: ${cuba.desktop.home}/conf.

Интерфейс: GlobalConfig

Используется во всех стандартных блоках.

cuba.connectionReadTimeout

Задает таймаут подключения клиентского блока к Middleware. Неотрицательное значение передается в метод setReadTimeout() класса URLConnection.

См. также cuba.connectionTimeout.

Значение по умолчанию: -1

Используется в блоках Web Client, Web Portal, Desktop Client.

cuba.connectionTimeout

Задает таймаут подключения клиентского блока к Middleware. Неотрицательное значение передается в метод setConnectTimeout() класса URLConnection.

См. также cuba.connectionReadTimeout.

Значение по умолчанию: -1

Используется в блоках Web Client, Web Portal, Desktop Client.

cuba.connectionUrlList

Задает список URL для подключения клиентских блоков к серверам Middleware.

Значением свойства должен быть один или несколько разделенных запятой URL вида http[s]://host[:port]/app-core, где host - имя сервера, port - порт сервера, app-core - имя веб-приложения, реализующего блок Middleware. Например:

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

В случае использования кластера серверов Middleware, для обеспечения отказоустойчивости и балансировки нагрузки необходимо перечислить их адреса через запятую:

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

При этом порядок серверов в данном списке определяет приоритет, в котором клиент будет пытаться направлять запросы. Например в данном случае клиент сначала попытается вызвать server1, если он недоступен - то server2. Если запрос к server2 завершился успешно, данный клиент ставит server2 первым в своем списке и продолжает работать с ним. После перезапуска клиента список восстанавливается в первоначальное значение. Для обеспечения равномерного распределения клиентов между серверами используется свойство cuba.randomServerPriority.

См. также свойство cuba.useLocalServiceInvocation.

Интерфейс: ClientConfig

Используется в блоках Web Client, Web Portal, Desktop Client.

cuba.creditsConfig

Конфигурационный параметр, задает набор файлов credits.xml, содержащих информацию об используемом программном обеспечении.

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources .

Используется в блоках Web Client и Desktop Client.

Пример:

cuba.creditsConfig=cuba-credits.xml reports-credits.xml credits.xml
cuba.dataSourceJndiName

Задает JNDI имя источника данных javax.sql.DataSource, через который производится обращение к базе данных приложения.

Значение по умолчанию: java:comp/env/jdbc/CubaDS

Используется в блоке Middleware.

cuba.dataDir

Конфигурационный параметр, задающий расположение рабочего каталога данного блока приложения.

Значение по умолчанию для блоков Middleware, Web Client, Web Portal: ${catalina.home}/work/${cuba.webContextName}, что в случае стандартного развертывания в Tomcat означает расположение внутри каталога tomcat/work в подкаталоге с именем текущего веб-приложения, например, tomcat/work/app-core.

Значение по умолчанию для блока Desktop Client: ${cuba.desktop.home}/work.

Интерфейс: GlobalConfig

Используется во всех стандартных блоках.

cuba.dbDir

Конфигурационный параметр, задающий расположение каталога скриптов базы данных.

Значение по умолчанию: ${catalina.home}/webapps/${cuba.webContextName}/WEB-INF/db, что означает расположение в подкаталоге WEB-INF/db каталога текущего веб-приложения Tomcat.

Интерфейс: ServerConfig

Используется в блоке Middleware.

cuba.dbmsType

Задает тип используемой базы данных. Совместно с cuba.dbmsVersion влияет на выбор имплементаций интерфейсов интеграции с СУБД и на поиск скриптов создания и обновления БД.

Подробнее см. Раздел 4.3.1, «Типы СУБД»

Значение по умолчанию: hsql

Используется в блоке Middleware.

cuba.dbmsVersion

Необязательное свойство, задающее версию используемой базы данных. Совместно с cuba.dbmsType влияет на выбор имплементаций интерфейсов интеграции с СУБД и на поиск скриптов создания и обновления БД.

Подробнее см. Раздел 4.3.1, «Типы СУБД»

Значение по умолчанию: отсутствует

Используется в блоке Middleware.

cuba.defaultQueryTimeoutSec

Задает таймаут транзакции по умолчанию.

Значение по умолчанию: 0, означает, что таймаут отсутствует.

Интерфейс: ServerConfig

Используется в блоке Middleware.

cuba.desktop.useServerTime

Включает корректировку времени, выдаваемого интерфейсом TimeSource блока DesktopClient - оно становится примерно равным времени Middleware, к которому подключен данный клиент.

Значение по умолчанию: true

Интерфейс: DesktopConfig

Используется в блоке DesktopClient.

cuba.desktop.useServerTimeZone

Устанавливает в JVM блока DesktopClient timezone Middleware, к которому подключен данный клиент.

Значение по умолчанию: true

Интерфейс: DesktopConfig

Используется в блоке DesktopClient.

cuba.disableOrmXmlGeneration

Запрещает автоматическую генерацию файла orm.xml для расширенных сущностей. Дает возможность вручную создать такой файл и зарегистрировать в параметре openjpa.MetaDataFactory файла persistence.xml .

Значение по умолчанию: false, означает что orm.xml будет создан автоматически при наличии расширенных сущностей.

Используется в блоке Middleware.

cuba.dispatcherSpringContextConfig

Конфигурационный параметр, задает набор файлов dispatcher-spring.xml в клиентских блоках.

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources .

Используется в блоках Web Client, Web Portal.

Пример:

cuba.dispatcherSpringContextConfig=cuba-portal-dispatcher-spring.xml portal-dispatcher-spring.xml
cuba.download.directories

Задает список каталогов, из которых можно загружать с Middleware файлы через com.haulmont.cuba.core.controllers.FileDownloadController. Загрузка файлов используется в частности механизмом отображения журналов сервера, доступным через экран Администрирование -> Журнал сервера веб-клиента.

Список задается через ";".

Значение по умолчанию: ${cuba.tempDir};${cuba.logDir}, означает что файлы можно загружать из временного каталога и каталога логов.

Используется в блоке Middleware.

cuba.email.*

Параметры отправки email, подробно описаны в Раздел 4.7.2.3, «Настройка параметров отправки email»

cuba.fileStorageDir

Задает корни структуры каталогов файлового хранилища. Подробнее см. Раздел 4.7.8.3, «Стандартная реализация хранилища»

Значение по умолчанию: null

Используется в блоке Middleware.

cuba.gui.genericFilterChecking

Оказывает влияние на поведение компонента Filter.

При установке в true пользователь не может применить фильтр, не введя ни одного параметра.

Значение по умолчанию: false

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.gui.genericFilterControlsLayout

Задает шаблон расположения элементов компонента Filter. Каждый элемент имеет следующий формат: [component_name | options-comma-separated], например [pin | no-caption, no-icon].

Доступные элементы:

  • filters_popup - кнопка с выпадающим списком фильтров, объединенная с кнопкой Search button.

  • filters_lookup - поле с выпадающим списком фильтров. При использовании этого элемента необходимо добавить также элемент search.

  • search - кнопка Search. Не добавляйте, если уже используется filters_popup.

  • add_condition - кнопка-ссылка для добавления новых условий.

  • spacer - пустое пространство между элементами.

  • settings - кнопка с выпадающим списком Settings. Элементы списка кнопки задаются в виде опций (см. ниже).

  • max_results - группа компонентов для задания максимального количества извлекаемых записей.

  • fts_switch - флажок для переключения в режим полнотекстового поиска.

Следующие действия могут быть опциями элемента settings: save, save_as, edit, remove, pin, make_default, save_search_folder, save_app_folder.

Они также могут быть использованы и как независимые элементы компоновки. В этом случае они могут иметь следующие опции:

  • 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] \
[max_results] [fts_switch]

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.gui.genericFilterManualApplyRequired

Оказывает влияние на поведение компонента Filter.

При установке в true экраны, содержащие фильтры, не будут автоматически загружать ссответствующие источники данных до тех пор, пока пользователь не нажмет кнопку Применить фильтра.

При открытии экрана списка с помощью папки приложения или папки поиска значение cuba.gui.genericFilterManualApplyRequired не учитывается, то есть в этом случае фильтр будет применяться. Фильтр не применится, если значение атрибута applyDefault у папки явно установлено в false.

Значение по умолчанию: false

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.gui.layoutAnalyzerEnabled

Позволяет отключить команду анализа компоновки экрана Analyze layout, доступную в контекстном меню вкладок главного окна и в заголовках модальных окон.

Значение по умолчанию: true

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.gui.genericFilterColumnsQty

Определяет количество колонок для размещения условий фильтра.

Значение по умолчанию: 3

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.gui.genericFilterConditionsLocation

Определяет положение панели условий фильтра. Доступны два положения: top (над элементами управления фильтром) и bottom (под элементами управления фильтром).

Значение по умолчанию: top

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.gui.genericFilterPopupListSize

Определяет число элементов, отображающихся в выпадающем списке кнопки Search. Если количество фильтров превышает значение, к выпадающему списку добавляется действие Show more.... Действие открывает новое диалоговое окно со списком всех доступных фильтров.

Значение по умолчанию: 10

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.groovyEvaluationPoolMaxIdle

Задает максимальное число неиспользуемых скомпилированных выражений Groovy в пуле при выполнении метода Scripting.evaluateGroovy(). Данный параметр рекомендуется увеличивать при потребности в интенсивном исполнении выражений Groovy, например, вследствие большого количества папок приложения.

Значение по умолчанию: 8

Используется во всех стандартных блоках.

cuba.groovyEvaluatorImport

Задает список классов, импортируемых всеми выполняемыми через Scripting выражениями на Groovy.

Имена классов в списке разделяются запятой или точкой с запятой.

Значение по умолчанию: com.haulmont.cuba.core.global.PersistenceHelper

Используется во всех стандартных блоках.

Пример:

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

Определяет форму диалога, возникающего при попытке закрытия экрана, имеющего несохраненные изменения в источниках данных.

Значение true задает форму с тремя вариантами выбора: сохранить изменения, не сохранять, либо не закрывать экран.

Значение false задает форму с двумя вариантами: закрыть экран не сохраняя изменений, либо не закрывать экран.

Значение по умолчанию: true

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.httpSessionExpirationTimeoutSec

Задает таймаут бездействия HTTP-сессии в секундах.

Значение по умолчанию: 1800

Интерфейс: WebConfig

Используется в блоке Web Client.

Рекомендуется выставлять параметры cuba.userSessionExpirationTimeoutSec и cuba.httpSessionExpirationTimeoutSec в одинаковое значение.

cuba.inMemoryDistinct

Включает режим фильтрации дубликатов записей в памяти, вместо select distinct на уровне базы данных. Используется в DataManager.

Значение по умолчанию: false

Интерфейс: ServerConfig

Используется в блоке Middleware.

cuba.jmxUserLogin

Логин пользователя, под которым выполняется вход в систему при системной аутентификации.

Значение по умолчанию: admin

Используется в блоке Middleware.

cuba.licensePath

Путь к файлу лицензии на использование платформы CUBA. Файл загружается по правилам интерфейса Resources. См. также Раздел 6.6, «Использование файла лицензии».

Значение по умолчанию: /cuba.license

Интерфейс: ServerConfig

Используется в блоке Middleware.

cuba.localeSelectVisible

Включает или отключает возможность пользователя выбирать язык интерфейса при входе в систему.

Если cuba.localeSelectVisible=false, то локаль пользовательской сессии выбирается следующим образом:

  • если для данного экземпляра сущности User установлен атрибут language, то устанавливается локаль для этого языка;

  • если язык операционной системы пользователя присутствует в списке доступных (заданных свойством cuba.availableLocales ), то выбирается он;

  • в противном случае выбирается язык, заданный первым в свойстве cuba.availableLocales .

Значение по умолчанию: true

Интерфейс: GlobalConfig

Используется во всех стандартных блоках.

cuba.logDir

Конфигурационный параметр, задающий расположение каталога журналов данного блока приложения.

Значение по умолчанию для блоков Middleware, Web Client, Web Portal: ${catalina.home}/logs, что в случае стандартного развертывания в Tomcat означает каталог tomcat/logs.

Значение по умолчанию для блока Desktop Client: ${cuba.desktop.home}/logs.

Интерфейс: GlobalConfig

Используется во всех стандартных блоках.

cuba.mainMessagePack

Задает главный пакет сообщений данного блока приложения.

Значением свойства может быть либо один пакет, либо список пакетов, разделенный пробелами.

Используется во всех стандартных блоках.

Пример:

cuba.mainMessagePack=com.haulmont.cuba.web com.sample.sales.web
cuba.manualScreenSettingsSaving

Если установлено в true, экраны не будут сохранять свои настройки автоматически при закрытии. В этом режиме пользователь может сохранить или сбросить настройки экрана, используя контекстное меню на вкладке экрана или на заголовке диалогового окна.

Значение по умолчанию: false

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.menuConfig

Конфигурационный параметр, задает набор файлов menu.xml .

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources .

Используется в блоках Web Client и Desktop Client.

Пример:

cuba.menuConfig=cuba-web-menu.xml web-menu.xml
cuba.metadataConfig

Конфигурационный параметр, задает набор файлов metadata.xml .

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources .

Используется в блоках Middleware, Web Client и Desktop Client.

Пример:

cuba.metadataConfig=cuba-metadata.xml metadata.xml
cuba.passwordEncryptionModule

Задает имя бина, используемого для хэширования паролей пользователей.

Значение по умолчанию: cuba_Sha1EncryptionModule

Используется во всех стандартных блоках.

cuba.passwordPolicyEnabled

Определяет, нужно ли применять политику проверки пароля. Если свойство имеет значение true, то все новые задаваемые пользователями пароли будут проверяться в соответствии со свойством cuba.passwordPolicyRegExp .

Значение по умолчанию: false

Интерфейс: ClientConfig

Используется в блоках клиентского уровня: Web Client, Web Portal, Desktop Client.

cuba.passwordPolicyRegExp

В данном свойстве задается регулярное выражение, которое используется в политике проверки пароля.

Значение по умолчанию:

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

Это означает, что в пароль должен содержать от 6 до 20 символов, в нем можно использоваться цифры, символы и буквы латинского алфавита. При этом обязательно в пароле должна быть хотя бы одна цифра, одна буква в нижнем регистре и одна буква в верхнем регистре. Более подробная информация о синтаксисе регулярных выражений можно найти на сайтах: http://ru.wikipedia.org/wiki/Регулярные_выражения и http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html

Интерфейс: ClientConfig

Используется в блоках клиентского уровня: Web Client, Web Portal, Desktop Client.

cuba.permissionConfig

Конфигурационный параметр, задает набор файлов permissions.xml .

Используется в блоках Web Client и Desktop Client.

Пример:

cuba.permissionConfig=cuba-web-permissions.xml web-permissions.xml
cuba.persistenceConfig

Конфигурационный параметр, задает набор файлов persistence.xml .

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources .

Используется в блоках Middleware, Web Client и Desktop Client.

Пример:

cuba.persistenceConfig=cuba-persistence.xml persistence.xml
cuba.portal.anonymousUserLogin

Логин пользователя системы, который используется для создания анонимной пользовательской сессии в блоке Web Portal.

Пользователь с таким логином должен быть создан в подсистеме безопасности, и ему должны быть назначены соответствующие права. Пароль пользователя игнорируется, так как анонимная сессия портала создается методом loginTrusted() с передачей пароля, указанного в свойстве cuba.trustedClientPassword .

Интерфейс: PortalConfig

Используется в блоке Web Portal.

cuba.randomServerPriority

Задает режим случайного выбора сервера Middleware в кластере для обеспечения равномерного распределения клиентов между серверами.

См. также свойство cuba.connectionUrlList.

Значение по умолчанию: false

Используется в блоках Web Client, Web Portal, Desktop Client.

cuba.remotingSpringContextConfig

Конфигурационный параметр, задает набор файлов remoting-spring.xml в блоке Middleware.

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources .

Используется в блоке Middleware.

Пример:

cuba.remotingSpringContextConfig=cuba-remoting-spring.xml remoting-spring.xml
cuba.rest.productionMode

Включает режим экспуатации REST API, при котором текст исключительных ситуаций не возвращается клиенту.

Интерфейс: RestConfig

Используется в блоке Web Portal.

Значение по умолчанию: false

cuba.rest.apiVersion

Задает версию REST API. Значение 1 включает REST API, использовавшийся в версиях платформы до 5.4. Значение 2 включает новую версию REST API с поддержкой вызова сервисов.

Интерфейс: RestConfig

Используется в блоке Web Portal.

Значение по умолчанию: 2

cuba.restApiUrl

URL, по которому доступен REST API приложения.

Интерфейс: GlobalConfig

Может использоваться во всех стандартных блоках.

Значение по умолчанию: http://localhost:8080/app-portal/api

cuba.restServicesConfig

Конфигурационный параметр, задает набор файлов, в которых перечисляются сервисы, доступные для вызова через REST API приложения.

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources.

XSD файла доступна по адресу http://schemas.haulmont.com/cuba/5.6/restapi-service-v2.xsd.

Используется в блоке Web Portal.

Значение по умолчанию: cuba-rest-services.xml

Пример:

cuba.restServicesConfig = cuba-rest-services.xml app-rest-services.xml
cuba.schedulingActive

Включает и выключает механизм выполнения назначенных заданий CUBA.

Значение по умолчанию: false

Интерфейс: ServerConfig

Используется в блоке Middleware.

cuba.springContextConfig

Конфигурационный параметр, задает набор файлов spring.xml в каждом стандартном блоке приложения.

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources .

Используется во всех стандартных блоках.

Пример:

cuba.springContextConfig=cuba-spring.xml spring.xml
cuba.supportEmail

Задает email, на который отправляются отчеты об исключениях из окна стандартного обработчика, и сообщения пользователей из экрана Help -> Feedback.

Если данное свойство установлено в пустую строку, кнопка Report в окне обработчика исключений не показывается.

Для успешной отсылки email необходимо настроить параметры, описанные в разделе Раздел 4.7.2.3, «Настройка параметров отправки email»

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.systemInfoScriptsEnabled

Разрешает показ SQL-скриптов добавления/изменения/извлечения экземпляра сущности в окне System Information.

Данные скрипты фактически показывают содержимое строк базы данных, хранящих выбранный экземпляр сущности, независимо от настроек безопасности, в которых некоторые атрибуты могут быть запрещены. Поэтому рекомендуется либо отобрать право на CUBA / Generic UI / System Information для всех ролей пользователей, кроме администраторов, либо установить свойство cuba.systemInfoScriptsEnabled для всего приложения в false.

Значение по умолчанию: true

Интерфейс: ClientConfig

Используется в блоках Web Client и Desktop Client.

cuba.tempDir

Конфигурационный параметр, задающий расположение временного каталога данного блока приложения.

Значение по умолчанию для блоков Middleware, Web Client, Web Portal: ${catalina.home}/temp/${cuba.webContextName}, что в случае стандартного развертывания в Tomcat означает расположение внутри каталога tomcat/temp в подкаталоге с именем текущего веб-приложения, например, tomcat/temp/app-core.

Значение по умолчанию для блока Desktop Client: ${cuba.desktop.home}/temp.

Интерфейс: GlobalConfig

Используется во всех стандартных блоках.

cuba.themeConfig

Задает набор файлов *-theme.properties, в которых описаны переменные тем, такие как размеры диалоговых окон и ширина полей ввода по умолчанию.

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources.

Значение по умолчанию для Web Client: havana-theme.properties halo-theme.properties

Значение по умолчанию для Desktop Client: nimbus-theme.properties

Используется в блоках Web Client и Desktop Client.

cuba.triggerFilesCheck

Позволяет отключить обработку триггер-файлов вызова бинов.

Триггер-файл представляет собой файл, помещаемый в подкаталог triggers временного каталога данного блока приложения. Имя триггер-файла состоит из двух частей, разделенных точкой. Первая часть соответствует имени бина, вторая - имени вызываемого метода бина, например cuba_Messages.clearCache. Обработчик триггер-файлов следит за их появлением, вызывает соответствующие методы и удаляет файлы.

В платформе вызов обработчика задан в файле cuba-web-spring.xml, то есть по умолчанию обработка триггер-файлов производится для блока Web Client. На уровне проекта можно аналогично запустить обработку для других модулей, периодически вызывая метод process() бина cuba_TriggerFilesProcessor.

См. также свойство cuba.triggerFilesCheckInterval.

Значение по умолчанию: true

Используется в блоках, для которых настроена обработка, по умолчанию - Web Client.

cuba.triggerFilesCheckInterval

Устанавливает период в миллисекундах обработки триггер-файлов вызова бинов, заданный в файле cuba-web-spring.xml.

См. также свойство cuba.triggerFilesCheck.

Значение по умолчанию: 5000

Используется в блоке Web Client.

cuba.trustedClientPassword

Пароль, используемый методом LoginService.loginTrusted(). Средний слой может аутентифицировать пользователей, подключающихся через доверенный клиентский блок, без проверки пользовательского пароля.

Это свойство используется в случае, если пароли пользователей не хранятся в БД, и реальную аутентификацию выполняет сам клиентский блок, например, путем интеграции с Active Directory.

Интерфейсы: ServerConfig, WebConfig

Используется в блоках: Middleware, Web Client, Web Portal.

cuba.trustedClientPermittedIpMask

Маска IP адресов, с которых возможен вызов метода LoginService.loginTrusted(), в формате регулярного выражения.

Значение по умолчанию: 127\.0\.0\.1

Интерфейсы: ServerConfig, WebConfig

Используется в блоках: Middleware, Web Client, Web Portal.

cuba.uniqueConstraintViolationPattern

Регулярное выражение, по которому определяется, что данное исключение произошло по причине нарушения ограничения уникальности в базе данных. Имя индекса, поддерживающего ограничение, должно возвращаться первой или второй группой выражения. Например:

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

Имя индекса можно использовать для выдачи пользователю локализованного сообщения о том, для какой сущности нарушено ограничение. Для этого в главном пакете сообщений необходимо задать ключи, соответствующие именам индексов. Например:

IDX_SEC_USER_UNIQ_LOGIN = A user with the same login already exists

Данное свойство позволяет настроить реакцию на исключения уникальности в зависимости от используемой версии и локали сервера базы данных.

Значение по умолчанию: возвращается методом PersistenceManagerService.getUniqueConstraintViolationPattern() для соответствующей СУБД.

Используется во всех клиентских блоках приложения.

cuba.useCurrentTxForConfigEntityLoad

Если значение данного свойства true, то при загрузке экземпляров сущностей через конфигурационные интерфейсы будет использоваться текущая транзакция (если таковая имеется в данный момент), что может положительно сказаться на производительности. В противном случае всегда создается и завершается новая транзакция и возвращается detached экземпляр.

Значение по умолчанию: false

Используется в блоке Middleware.

cuba.useLocalServiceInvocation

При установке данного свойства в true и в случае быстрого развертывания в Tomcat блоки Web Client и Web Portal вызывают сервисы Middleware в обход сетевого стека, что положительно сказывается на производительности системы. В других вариантах развертывания данное свойство необходимо установить в false.

Значение по умолчанию: true

Используется в блоках Web Client и Web Portal.

cuba.user.fullNamePattern

Задает шаблон формирования полного имени пользователя.

Значение по умолчанию: {FF| }{LL}

Полное имя можно сформировать по шаблону из имени, отчества и фамилии пользователя. В шаблоне используются следующие правила:

  • Фигурными скобками {} разделяются части шаблона между собой

  • Правила формирования шаблона внутри фигурных скобок: один из следующих символов и далее, без пробела, символ |.

    LL означает фамилию пользователя, написанную в полном варианте (Иванов)

    L означает фамилию пользователя, написанную в кратком варианте (И)

    FF означает имя пользователя, написанного в полном варианте (Петр)

    F означает фамилию пользователя, написанную в кратком варианте (П)

    MM означает отчество пользователя, написанное в полном варианте (Сергеевич)

    M означает отчество пользователя, написанное в кратком варианте (С)

  • После символа | могут идти любые символы, в том числе, и пробел.

Используется в блоках Web Client и Desktop Client.

cuba.user.namePattern

Задает шаблон отображения имени экземпляра сущности User (пользователь). Данное имя отображается в том числе в правом верхнем углу главного окна системы.

Значение по умолчанию: {1} [{0}]

Вместо {0} подставляется атрибут login, вместо {1} - атрибут name.

Используется в блоках Middleware, Web Client, Desktop Client.

cuba.userSessionExpirationTimeoutSec

Задает таймаут неактивности сессии пользователя в секундах.

Значение по умолчанию: 1800

Интерфейс: ServerConfig

Используется в блоке Middleware.

Рекомендуется выставлять параметры cuba.userSessionExpirationTimeoutSec и cuba.httpSessionExpirationTimeoutSec в одинаковое значение.

cuba.userSessionProviderUrl

URL для соединения с блоком Middleware, через который выполняется вход пользователей в систему.

Этот параметр необходимо устанавливать в дополнительных блоках среднего слоя, которые выполняют запросы клиентов, но не содержат общего кэша пользовательских сессий. Тогда в начале выполнения запроса при отсутствии требуемой сессии в локальном кэше данный блок вызовет метод LoginService.getSession() по указанному URL, и в случае успеха закэширует полученную сессию у себя.

Интерфейс: ServerConfig

Используется в блоке Middleware.

cuba.viewsConfig

Конфигурационный параметр, задающий набор файлов views.xml, автоматически развертываемых на старте приложения. См. Раздел 4.2.3, «Представления»

Используется во всех стандартных блоках.

Пример:

cuba.viewsConfig=cuba-views.xml reports-views.xml views.xml
cuba.webAppUrl

URL, по которому доступен Web Client приложения.

Используется, в частности, для формирования ссылок на экраны приложения извне, а также классом ScreenHistorySupport.

Интерфейс: GlobalConfig

Может использоваться во всех стандартных блоках.

Значение по умолчанию: http://localhost:8080/app

cuba.windowConfig

Конфигурационный параметр, задает набор файлов screens.xml .

Значением свойства должен быть список имен файлов, разделенный пробелами. Файлы загружаются по правилам интерфейса Resources .

Используется в блоках Web Client и Desktop Client.

Пример:

cuba.windowConfig=cuba-web-screens.xml web-screens.xml
cuba.web.allowHandleBrowserHistoryBack

Позволяет обрабатывать в приложении нажатия на кнопку Back браузера путем переопределения метода AppWindow.onHistoryBackPerformed(). Если свойство установлено в true, стандартное поведение браузера заменяется на вызов этого метода.

См. Раздел 4.5.8, «Специфика Web Client».

Значение по умолчанию: true

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.appFoldersRefreshPeriodSec

Период по умолчанию обновления папок приложения в секундах.

Значение по умолчанию: 180

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.appWindowMode

Задает начальный режим главного окна: с вкладками или одноэкранный (TABBED или SINGLE). В одноэкранном режиме экран, открываемый в режиме NEW_TAB, отображается не в новой вкладке, а полностью заменяет текущий экран. Это может быть удобно для простых приложений и неопытных пользователей.

Пользователь впоследствии может задать желаемый режим через экран Help > Settings.

Значение по умолчанию: TABBED

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.foldersPaneDefaultWidth

Ширина по умолчанию панели папок в пикселях.

Значение по умолчанию: 200

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.foldersPaneEnabled

Если false, то функциональность панели папок отключена.

Значение по умолчанию: true

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.foldersPaneVisibleByDefault

Если true, то при первом входе пользователя в систему панель папок будет отображаться в развернутом состоянии, если false - то в свернутом.

Значение по умолчанию: false

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.linkHandlerActions

Определяет список команд, передаваемых в URL, для которых вызывается обработка бином LinkHandler. См. Раздел 4.7.13, «Ссылки на экраны»

Элементы списка отделяются символом |.

Значение по умолчанию: open|o

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.loginDialogDefaultUser

Задает имя пользователя по умолчанию. Оно будет автоматически подставляться в экране входа в систему, что удобно в процессе разработки приложения. В режиме эксплуатации приложения в данном свойстве необходимо задать значение <disabled>.

Значение по умолчанию: admin

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.loginDialogDefaultPassword

Задает пароль пользователя по умолчанию. Он будет автоматически подставляться в экране входа в систему, что удобно в процессе разработки приложения. В режиме эксплуатации приложения в данном свойстве необходимо задать значение <disabled>.

Значение по умолчанию: admin

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.maxTabCount

Задает максимальное количество вкладок с экранами, которые пользователь может открыть в главном окне приложения. Значение 0 снимает ограничение.

Значение по умолчанию: 7

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.rememberMeEnabled

Управляет отображением флажка Remeber Me в стандартном экране входа в систему в веб клиенте.

Значение по умолчанию: true

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.resourcesRoot

Задает расположение каталога, из которого могут быть загружены файлы для вывода на экран компонентом Embedded. Например:

cuba.web.resourcesRoot=${cuba.confDir}/resources

Значение по умолчанию: null

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.showBreadCrumbs

Позволяет скрыть панель breadcrumbs, которая раполагается в верхней части рабочей области главного окна.

Значение по умолчанию: true

Интерфейс: WebConfig

Используется в блоке Client block.

cuba.web.showFolderIcons

Задает отображение пиктограмм в панели папок. Если включено, то используются следующие файлы каталога темы приложения:

  • icons/app-folder-small.png - для папок приложения

  • icons/search-folder-small.png - для папок поиска

  • icons/set-small.png - для наборов

Значение по умолчанию: false

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.table.cacheRate

Регулирует кэширование данных компонента Table в браузере. Количество закэшированных строк будет равняться cacheRate умноженному на pageLength как снизу так и сверху видимой области.

Значение по умолчанию: 2

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.table.pageLength

Устанавливает количество строк, которое загружается с сервера в браузер когда компонент Table отрисовывается первый раз после обновления. См. также cuba.web.table.cacheRate.

Значение по умолчанию: 15

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.theme

Задает имя темы, используемой по умолчанию в веб клиенте. См. также свойство cuba.themeConfig.

Значение по умолчанию: havana

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.useFontIcons

При включенном свойстве для темы halo в качестве пиктограмм стандартных действий и экранов платформы используются элементы шрифта Font Awesome вместо файлов изображений.

Соответствие между именем, указанным в свойстве icon действия или визуального компонента, и элементом шрифта, задается в файле halo-theme.properties платформы. В нем ключи, начинающиеся с cuba.web.icons соответствуют именам пиктограмм, а их значения - константам перечисления com.vaadin.server.FontAwesome. Например, элемент шрифта для пиктограммы стандартного действия create, задается строкой:

cuba.web.icons.create.png = FILE_O

Значение по умолчанию: true

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.useInverseHeader

Для темы Halo или ее наследников управляет цветом заголовка веб-клиента. Если true, то заголовок темный (инверсный), если false - заголовок приобретает цвет основного фона приложения.

Данное свойство не действует, если в теме установлена переменная

$v-support-inverse-menu: false;

Это имеет смысл для темной темы, если пользователю дана возможность переключаться между светлой и темной темой. Тогда в светлой теме заголовок будет инверсным, а в темной основного цвета фона.

Значение по умолчанию: true

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.useLightHeader

Включает формирование компактной вехней части окна - лого, строка меню, имя пользователя и кнопка логаута в одну строку. В выключенном состоянии методом AppWindow.createTitleLayout() формируется дополнительная область сверху.

Значение по умолчанию: true

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.viewFileExtensions

Задает список расширений файлов, отображаемых в окне браузера при выгрузке файла через ExportDisplay.show(). Разделителем элементов списка является символ |.

Значение по умолчанию: htm|html|jpg|png|jpeg|pdf

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.web.showBreadCrumbs

Позволяет отключить панель навигации (breadcrumbs).

Значение по умолчанию: true

Интерфейс: WebConfig

Используется в блоке Web Client.

cuba.webContextName

Конфигурационный параметр, задающий имя контекста веб-приложения. Как правило, эквивалентен имени каталога или WAR-файла, содержащего данный блок приложения.

Интерфейс: GlobalConfig

Используется в блоках Middleware, Web Client, Web Portal.

Например, для блока Middleware, расположенного в каталоге tomcat/webapps/app-core, и доступного по URL http://somehost:8080/app-core данное свойство должно быть задано следующим образом:

cuba.webContextName=app-core
cuba.webHostName

Конфигурационный параметр, задающий имя хоста, на котором запущен данный блок приложения.

Значение по умолчанию: localhost

Интерфейс: GlobalConfig

Используется в блоках Middleware, Web Client, Web Portal.

Например, для блока Middleware, доступного по URL http://somehost:8080/app-core данное свойство должно быть задано следующим образом:

cuba.webHostName=somehost
cuba.webPort

Конфигурационный параметр, задающий имя порта, на котором запущен данный блок приложения.

Значение по умолчанию: 8080

Интерфейс: GlobalConfig

Используется в блоках Middleware, Web Client, Web Portal.

Например, для блока Middleware, доступного по URL http://somehost:8080/app-core данное свойство должно быть задано следующим образом:

cuba.webPort=8080