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

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

cuba.additionalStores

Задает имена дополнительных хранилищ данных, используемых в приложении.

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

Пример:

cuba.additionalStores = db1, mem1
cuba.allowQueryFromSelected

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

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

Хранится в базе данных.

Интерфейс: GlobalConfig

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

cuba.anonymousLogin

Логин пользователя, от имени которого создается анонимная сессия (см. cuba.anonymousSessionId).

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

cuba.anonymousSessionId

Задает UUID анонимной пользовательской сессии, которая доступна до логина пользователя. Данная сессия всегда создается автоматически на старте сервера. См. также cuba.anonymousLogin.

Интерфейс: GlobalConfig

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

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.timeoutCheckInterval

Задает интервал (в миллисекундах) проверки таймаутов фоновых задач.

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

Интерфейс: ClientConfig

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

cuba.bruteForceProtection.enabled

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

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

cuba.bruteForceProtection.blockIntervalSec

Задает интервал блокировки пользователя в секундах после превышения максимального числа неуспешных попыток входа, если свойство cuba.bruteForceProtection.enabled включено.

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

cuba.bruteForceProtection.maxLoginAttemptsNumber

Максимальное количество неуспешных попыток входа для пары логин + IP-адрес, если свойство cuba.bruteForceProtection.enabled включено.

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

cuba.cluster.enabled

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

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

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

cuba.cluster.jgroupsConfig

Путь к конфигурационному файлу JGroups. Файл загружается с помощью интерфейса Resources, поэтому может быть расположен в classpath или в конфигурационном каталоге.

Пример:

cuba.cluster.jgroupsConfig = my_jgroups_tcp.xml

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

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

cuba.cluster.messageSendingQueueCapacity

Ограничивает размер очереди сообщений кластера middleware. Если очередь переполняется, новые сообщения отбрасываются.

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

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

cuba.cluster.stateTransferTimeout

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

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

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

cuba.confDir

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

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

Значение по умолчанию для WAR и UberJAR: ${app.home}/${cuba.webContextName}/conf, что означает расположение в подкаталоге домашнего каталога приложения.

Значение по умолчанию для блока 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

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

Интерфейс: ClientConfig

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

cuba.creditsConfig

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

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

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

Пример:

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

Размер пакета, применямого в DataManager для загрузки ссылок из другого хранилища.

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

cuba.dataManagerChecksSecurityOnMiddleware

Указывает, что DataManager должен применять подсистемы безопасности когда вызывается из кода Middleware.

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

cuba.dataSourceJndiName

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

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

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

cuba.dataDir

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

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

Значение по умолчанию для WAR и UberJAR: ${app.home}/${cuba.webContextName}/work, что означает расположение в подкаталоге домашнего каталога приложения.

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

Интерфейс: GlobalConfig

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

cuba.dbDir

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

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

Значение по умолчанию для WAR и UberJAR: web-inf:db, что означает расположение в подкаталоге WEB-INF/db внутри WAR или UberJAR.

Интерфейс: ServerConfig

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

cuba.dbmsType

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

Подробнее см. Типы СУБД.

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

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

cuba.dbmsVersion

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

Подробнее см. Типы СУБД.

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

Используется в блоке 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.disableEscapingLikeForDataStores

Содержит список хранилищ данных, для которых запрещён оператор ESCAPE в JPQL-запросах, содержащих LIKE, в фильтрах.

Хранится в базе данных.

Интерфейс: GlobalConfig

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

cuba.disableOrmXmlGeneration

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

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

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

cuba.dispatcherSpringContextConfig

Аддитивное свойство, задающее файл dispatcher-spring.xml в клиентских блоках.

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

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

Пример:

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

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

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

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

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

cuba.email.*

Параметры отправки email, подробно описаны в Настройка параметров отправки email.

cuba.fileStorageDir

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

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

Интерфейс: ServerConfig

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

cuba.enableDeleteStatementInSoftDeleteMode

Переключатель для обратной совместимости. При установке в true, позволяет выполнять оператор JPQL delete from для soft-deleted сущностей при включенном режиме мягкого удаления. Такой оператор трансформируется в SQL, который удаляет экземпляры не помеченные на мягкое удаление. Это неинтуитивное поведение по умолчанию запрещено.

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

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

cuba.enableSessionParamsInQueryFilter

Переключатель для обратной совместимости. При установке в false условия в фильтре запросов источника данных и компонента Filter будут применяться только после передачи как минимум одного значения параметра, а параметры сессии работать не будут.

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

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

cuba.entityAttributePermissionChecking

При установке в true включает проверку прав на атрибуты сущностей на уровне Middleware. Если значением является false, права на атрибуты проверяются только на клиентском уровне, т.е. в Generic UI и REST API.

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

Хранится в базе данных.

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

cuba.entityLog.enabled

Активирует механизм журналирования сущностей.

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

Хранится в базе данных.

Интерфейс: EntityLogConfig

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

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.genericFilterChecking

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

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.genericFilterColumnsCount

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.genericFilterConditionsLocation

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

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

Хранится в базе данных.

Интерфейс: 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, clear_values.

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

  • 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 Client и Desktop Client.

cuba.gui.genericFilterManualApplyRequired

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

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

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.genericFilterMaxResultsOptions

Задает возможные значения списка Show rows компонента Filter.

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

Значение по умолчанию: NULL, 20, 50, 100, 500, 1000, 5000

Интерфейс: ClientConfig

Хранится в базе данных.

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

cuba.gui.genericFilterPopupListSize

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.genericFilterTrimParamValues

Определяет, нужно ли обрезать пробелы в начале и конце строки текстового поиска. Если установлено false, введённые строки будут использоваться без обрезки.

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.layoutAnalyzerEnabled

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.lookupFieldPageLength

Задает количество опций на одной странице выпадающего списка в компонентах LookupField и LookupPickerField. Может быть переопределено для конкретного экземпляра компонента с помощью XML-атрибута pageLength.

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.manualScreenSettingsSaving

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.showIconsForPopupMenuActions

Включает отображение значков действий в пунктах контекстного меню Table и PopupButton.

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.systemInfoScriptsEnabled

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

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.gui.useSaveConfirmation

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

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

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

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 Client и Desktop Client.

cuba.healthCheckResponse

Задает текст, возвращаемый запросом на health check URL.

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

Интерфейс: GlobalConfig

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

cuba.httpSessionExpirationTimeoutSec

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

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

Интерфейс: WebConfig

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

Tip

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

cuba.iconsConfig

Аддитивное свойство, задающее наборы значков.

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

Пример использования:

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

Для SSO Identity Provider запрещает доступ к IDP HTTP cookie из JavaScript.

Значение по умолчанию: true (доступ из JS запрещен)

Интерфейс: IdpConfig

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

cuba.idp.cookieMaxAgeSec

Для SSO Identity Provider устанавливает время жизни IDP HTTP cookie в секундах.

Значение по умолчанию: 31536000 (~1 год)

Интерфейс: IdpConfig

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

cuba.idp.serviceProviderLogoutUrls

Для SSO Identity Provider устанавливает список URL, которые используются для уведомления SP о логауте или истечении сессии пользователей. Значения перечисляются через запятую.

Например:

cuba.idp.serviceProviderLogoutUrls = http://foo:8081/app/dispatch/idpc/logout,http://bar:8082/app/dispatch/idpc/logout

Интерфейс: IdpConfig

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

cuba.idp.serviceProviderUrls

Для SSO Identity Provider устанавливает список URL сервис-провайдеров. Значения перечисляются через запятую. Символ '/' в конце URL обязателен.

Например:

cuba.idp.serviceProviderUrls = http://foo:8081/app/,http://bar:8082/app/

Интерфейс: IdpConfig

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

cuba.idp.serviceProviderUrlMasks

Для SSO Identity Provider устанавливает маски разрешенных URL сервис-провайдеров в формате Java Regex. Значения перечисляются через запятую. Позволяет корректно обрабатывать внешние ссылки, когда пользователь не авторизован в системе.

Рекомендуется внимательно прописывать маски, чтобы избежать переадресации на сомнительные источники, поэтому символ '/' в конце URL обязателен.

Пример:

cuba.idp.serviceProviderUrlMasks = http://your-foo.com/.*,http://your-bar.com/.*

Интерфейс: IdpConfig

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

cuba.idp.sessionExpirationTimeoutSec

Для SSO Identity Provider устанавливает таймаут неактивности сессий IDP в секундах.

Значение по умолчанию: 18000 (5 часов)

Интерфейс: IdpConfig

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

cuba.idp.sessionExpirationCheckIntervalMs

Для SSO Identity Provider устанавливает интервал проверки неактивности сессий IDP в миллисекундах.

Значение по умолчанию: 30000 (30 сек)

Интерфейс: IdpConfig

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

cuba.idp.standardAuthenticationUsers

Разделенный запятыми список логинов пользователей, которые могут входить в систему, используя только стандартную аутентификацию. Для этих пользователей внешняя аутентификация (IDP SSO) запрещена. См. также cuba.web.standardAuthenticationUsers.

Пустой список означает, что все могут использовать внешнюю аутентификацию, если она включена.

Пример использования:

cuba.web.standardAuthenticationUsers = admin

Значение по умолчанию: <empty list>

Интерфейс: IdpAuthConfig

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

cuba.idp.ticketExpirationTimeoutSec

Для SSO Identity Provider устанавливает таймаут тикетов SSO в секундах.

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

Интерфейс: IdpConfig

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

cuba.idp.trustedServicePassword

Для SSO Identity Provider устанавливает пароль, используемый в коммуникации server-to-server между SP и IDP.

Интерфейс: IdpConfig

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

cuba.inMemoryDistinct

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

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

cuba.jmxUserLogin

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

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

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

cuba.keyForSecurityTokenEncryption

Используется в качестве ключа AES-шифрования токена безопасности (security token). Токен посылается внутри экземпляра сущности, когда он загружается со среднего слоя в следующих случаях:

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

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

Интерфейс: ServerConfig

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

cuba.numberIdCacheSize

Когда в памяти приложения с помощью метода Metadata.create() создается экземпляр сущности, унаследованной от BaseLongIdEntity или BaseIntegerIdEntity, ему сразу присваивается идентификатор. Значение идентификатора получается из механизма, который извлекает следующее число из последовательности в базе данных. Для того, чтобы уменьшить количество обращений к среднему слою и к БД, инкремент последовательности устанавливается по умолчанию в 100, что означает что фреймворк на самом деле получает диапазон значений при каждом обращении к БД. Этот диапазон "кэшируется" и механизм выдает значения идентификаторов без обращений к БД, пока не исчерпается диапазон.

Данное свойство задает инкремент последовательностей и соответствующий размер кэшированного диапазона в памяти.

Warning

Если вы меняете значение данного свойства когда в БД уже хранятся сущности, необходимо также пересоздать имеющиеся последовательности с новым инкрементом (равным cuba.numberIdCacheSize) и начальными значениями, соответствующими максимальным имеющимся идентификаторам.

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

Интерфейс: GlobalConfig

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

cuba.localeSelectVisible

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

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

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

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

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

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

Интерфейс: GlobalConfig

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

cuba.logDir

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

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

Значение по умолчанию для WAR и UberJAR: ${app.home}/logs, что означает расположение в подкаталоге logs домашнего каталога приложения.

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

Интерфейс: GlobalConfig

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

cuba.mainMessagePack

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

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

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

Пример:

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

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

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

Хранится в базе данных.

Интерфейс: ClientConfig

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

cuba.menuConfig

Аддитивное свойство, задающее файл menu.xml.

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

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

Пример:

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

Аддитивное свойство, задающее файл metadata.xml.

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

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

Пример:

cuba.metadataConfig = +com/company/sample/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 символов, в нем можно использоваться цифры, символы и буквы латинского алфавита. При этом обязательно в пароле должна быть хотя бы одна цифра, одна буква в нижнем регистре и одна буква в верхнем регистре. Более подробную информацию о синтаксисе регулярных выражений можно найти на сайтах: https://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.performanceTestMode

Должно быть установлено в true, когда приложение выполняет тесты производительности.

Интерфейс: GlobalConfig

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

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

cuba.permissionConfig

Аддитивное свойство, задающее файл permissions.xml.

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

Пример:

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

Аддитивное свойство, задающее файл persistence.xml.

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

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

Пример:

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

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

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

Интерфейс: PortalConfig

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

cuba.queryCache.enabled

При установке в false отключает кэш запросов.

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

Интерфейс: QueryCacheConfig

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

cuba.queryCache.maxSize

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

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

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

Интерфейс: QueryCacheConfig

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

cuba.remotingSpringContextConfig

Аддитивное свойство, задающее файл remoting-spring.xml в блоке Middleware.

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

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

Пример:

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

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

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

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

cuba.rest.anonymousEnabled

Разрешает анонимный доступ к REST API.

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

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

cuba.rest.client.id

Задает идентификатор клиента REST API. Клиент - это не пользователь платформы, а приложение (какой-либо веб-портал или мобильный клиент), использующий REST API. Идентификатор и пароль клиента используются для базовой аутентификации при доступе к URL для получения токена.

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

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

cuba.rest.client.authorizedGrantTypes

Определяеет список типов авторизации (grant type), поддерживаемых клиентом по умолчанию. Для отключения поддержки refresh-токенов, удалите элемент refresh_token из значения свойства.

Значение по умолчанию: password,external,refresh_token

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

cuba.rest.client.secret

Задает пароль клиента REST API. Клиент - это не пользователь платформы, а приложение (какой-либо веб-портал или мобильный клиент), использующий REST API. Идентификатор и пароль клиента используются для базовой аутентификации при доступе к URL для получения токена.

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

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

cuba.rest.client.tokenExpirationTimeSec

Задает время жизни access токена REST API в секундах для клиента по умолчанию.

Значение по умолчанию: 43200 (12 часов)

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

cuba.rest.client.refreshTokenExpirationTimeSec

Задает время жизни refresh токена REST API в секундах для клиента по умолчанию.

Значение по умолчанию: 31536000 (365 дней)

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

cuba.rest.deleteExpiredTokensCron

Задает выражение cron, определяющее расписание удаления истекших OAuth токенов из базы данных.

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

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

cuba.rest.jsonTransformationConfig

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

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

XSD файла доступна по адресу http://schemas.haulmont.com/cuba/6.9/rest-json-transformations.xsd.

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

Пример:

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

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

cuba.rest.maxUploadSize

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

Значение по умолчанию: 20971520 (20 Mb)

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

cuba.rest.requiresSecurityToken

Если установлен в true, то в JSON загружаемой из БД сущности включается дополнительный системный атрибут, и этот же атрибут ожидается от клиента при сохранении сущности. Подробнее см. Ограничения для атрибутов-коллекций.

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

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

cuba.rest.reuseRefreshToken

Определяет, должен ли refresh-токен быть повторно использован. Если установить значение в false, то когда access-токен запрашивается с помощью refresh-токена, то будет выдан новый refresh-токен, а старый будет удалён.

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

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

cuba.rest.servicesConfig

Аддитивное свойство задающее файл, который содержит список доступных для вызова через REST API сервисов.

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

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

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

Example:

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

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

cuba.rest.storeTokensInDb

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

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

cuba.rest.tokenMaskingEnabled

Определяет, должны ли токены REST API быть маскированы в логах приложения.

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

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

cuba.rest.queriesConfig

Аддитивное свойство задающее файл, который содержит список доступных для выполнения через REST API JPQL запросов.

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

XSD файла доступна по адресу http://schemas.haulmont.com/cuba/6.9/rest-queries.xsd.

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

Example:

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

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

cuba.schedulingActive

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

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

cuba.serialization.impl

Указывает имплементацию интерфейса Serialization, которая будет использоваться для сериализации объектов при их передаче между блоками приложения. Платформа содержит две имплементации:

  • com.haulmont.cuba.core.sys.serialization.StandardSerialization - стандартная Java-сериализация.

  • com.haulmont.cuba.core.sys.serialization.KryoSerialization - сериализация на базе фреймворка Kryo.

Значение по умолчанию: com.haulmont.cuba.core.sys.serialization.KryoSerialization

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

cuba.springContextConfig

Аддитивное свойство, задающее файл spring.xml в каждом стандартном блоке приложения.

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

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

Пример:

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

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

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

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

Значение по умолчанию: пустая строка.

Хранится в базе данных.

Интерфейс: WebConfig

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

cuba.tempDir

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

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

Значение по умолчанию для WAR и UberJAR: ${app.home}/${cuba.webContextName}/temp, что означает расположение в подкаталоге домашнего каталога приложения.

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

Интерфейс: GlobalConfig

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

cuba.testMode

Должно быть установлено в true, когда приложение выполняет автоматические UI-тесты.

Интерфейс: GlobalConfig

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

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

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, WebAuthConfig, PortalConfig

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

cuba.trustedClientPermittedIpList

Список IP адресов, с которых возможен вызов метода LoginService.loginTrusted().

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

Интерфейс: ServerConfig

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

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.useEntityDataStoreForIdSequence

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

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

Интерфейс: ServerConfig

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

cuba.useInnerJoinOnClause

Указывает что EclipseLink ORM будет использовать для inner joins выражение JOIN ON вместо условий в выражении WHERE.

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

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

cuba.useLocalServiceInvocation

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

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

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

cuba.useReadOnlyTransactionForLoad

Указывает, что все методы load в DataManager используют read-only транзакции.

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

Хранится в базе данных.

Интерфейс: ServerConfig

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

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.

Tip

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

cuba.userSessionLogEnabled

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

Хранится в базе данных.

Интерфейс: GlobalConfig.

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

cuba.userSessionProviderUrl

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

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

Интерфейс: ServerConfig

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

cuba.viewsConfig

Аддитивное свойство, задающее файл views.xml. См. Представления.

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

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

Пример:

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

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

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

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

Хранится в базе данных.

Интерфейс: GlobalConfig

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

cuba.windowConfig

Аддитивное свойство, задающее файл screens.xml.

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

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

Пример:

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

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

Значение по умолчанию: 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.closeIdleHttpSessions

Определяет, может ли веб клиент закрыть сессию и UI по истечению таймаута сессии после последнего non-heartbeat сообщения.

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

Интерфейс: WebConfig

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

cuba.web.componentsConfig

Аддитивное свойство, задающее файл конфигурации для компонентов приложения, поставляемых в отдельных JAR-файлах или указанных в дескрипторе cuba-ui-component.xml модуля web.

Пример:

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

Разрешает закрывать окно по умолчанию с помощью кнопки закрытия, контекстного меню TabSheet или нажатием клавиши ESC в случае, если выбран режим главного окна TABBED.

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

Интерфейс: WebConfig

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

cuba.web.defaultScreenId

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

Например:

cuba.web.defaultScreenId = sys$SendingMessage.browse

Интерфейс: WebConfig

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

cuba.web.externalAuthentication

Указывает на то, что аутентификация производится внешним механизмом, таким как LDAP или SSO Identity Provider. См. также cuba.web.externalAuthenticationProviderClass.

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

Интерфейс: WebAuthConfig

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

cuba.web.externalAuthenticationProviderClass

Класс, реализующий интерфейс CubaAuthProvider и используемый в случае если свойство cuba.web.externalAuthentication установлено в true.

См. разделы Интеграция с LDAP и Single-Sign-On для приложений CUBA для примеров.

Интерфейс: WebAuthConfig

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

cuba.web.foldersPaneDefaultWidth

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

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

Интерфейс: WebConfig

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

cuba.web.foldersPaneEnabled

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

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

Интерфейс: WebConfig

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

cuba.web.foldersPaneVisibleByDefault

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

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

Интерфейс: WebConfig

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

cuba.web.ldap.enabled

Включить/выключить интеграцию с LDAP в Web Client.

Например:

cuba.web.ldap.enabled = true

Интерфейс: WebLdapConfig

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

cuba.web.ldap.urls

Указывает URL сервера LDAP.

Например:

cuba.web.ldap.urls = ldap://192.168.1.1:389

Интерфейс: WebLdapConfig

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

cuba.web.ldap.base

Указывает base DN поиска имен пользователей.

Например
cuba.web.ldap.base = ou=Employees,dc=mycompany,dc=com

Интерфейс: WebLdapConfig

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

cuba.web.ldap.user

Указывает distinguished name системного пользователя, имеющего право на чтение информации из LDAP.

Например:

cuba.web.ldap.user = cn=System User,ou=Employees,dc=mycompany,dc=com

Интерфейс: WebLdapConfig

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

cuba.web.ldap.password

Пароль системного пользователя, заданного свойством cuba.web.ldap.user.

Например:

cuba.web.ldap.password = system_user_password

Интерфейс: WebLdapConfig

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

cuba.web.ldap.userLoginField

Название атрибута пользователя в LDAP, значение которого соответствует логину пользователя. По умолчанию sAMAccountName (подходит для Active Directory).

Например:

cuba.web.ldap.userLoginField = username

Интерфейс: WebLdapConfig

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

cuba.web.idp.enabled

Для SSO Service Provider разрешает использовать механизм логина Identity Provider.

Например:

cuba.web.idp.enabled = true

Интерфейс: WebIdpConfig

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

cuba.web.idp.enabled

Для SSO Service Provider включает/отключает механизм входа Identity Provider.

Например:

cuba.web.idp.enabled = true

Интерфейс: WebIdpConfig

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

cuba.web.idp.baseUrl

Для SSO Service Provider устанавливает Identity Provider URL. Стандартный CUBA IDP использует адрес idp/ (символ / в конце URL обязателен).

Например:

cuba.web.idp.baseUrl = http://main:8080/app/idp/

Интерфейс: WebIdpConfig

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

cuba.web.idp.trustedServicePassword

Для SSO Service Provider устанавливает пароль, используемый в коммуникации server-to-server между SP и IDP. Должен быть равен cuba.idp.trustedServicePassword.

Интерфейс: WebIdpConfig

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

cuba.web.linkHandlerActions

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

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

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

Интерфейс: WebConfig

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

cuba.web.loginDialogDefaultUser

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

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

Интерфейс: WebConfig

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

cuba.web.loginDialogDefaultPassword

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

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

Интерфейс: WebConfig

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

cuba.web.loginDialogPoweredByLinkVisible

Установите в false, чтобы скрыть ссылку "powered by CUBA Platform" на экране входа в систему.

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

Интерфейс: WebConfig

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

cuba.web.mainTabSheetMode

Определяет, какой компонент будет использован в режиме TABBED главного окна. Может иметь два строковых значения из перечисления MainTabSheetMode:

  • DEFAULT: будет использован компонент CubaTabSheet, который выгружает и загружает вкладку заново при переключении.

  • MANAGED: будет использован компонент CubaManagedTabSheet, который не выгружает содержимое вкладки главного TabSheet из памяти веб-браузера.

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

Интерфейс: WebConfig.

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

cuba.web.managedMainTabSheetMode

Если свойство cuba.web.mainTabSheetMode установлено в MANAGED, определяет, как компонент главного окна переключает вкладки главного TabSheet: только скрывает их или выгружает и загружает вкладку заново при переключении.

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

Интерфейс: WebConfig

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

cuba.web.maxTabCount

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

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

Интерфейс: WebConfig

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

cuba.web.productionMode

Позволяет полностью запретить консоль разработчика Vaadin в браузере, доступную через добавление ?debug к адресу приложения, тем самым, отключает доступ к возможностям отладки JavaScript и сокращает количество информации о сервере, выдаваемой браузеру.

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

Интерфейс: WebConfig

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

cuba.web.pushEnabled

Позволяет полностью запретить server push. В этом случае механизм фоновых задач не будет работать.

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

Интерфейс: WebConfig

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

cuba.web.pushLongPolling

Позволяет использовать long polling вместо WebSocket для реализации server push.

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

Интерфейс: WebConfig

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

cuba.web.pushLongPollingSuspendTimeoutMs

Задает push тайм-аут в миллисекундах, который используется в случае, если включен long polling вместо WebSocket для реализации server push, т.е. cuba.web.pushLongPolling="true".

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

Интерфейс: WebConfig

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

cuba.web.rememberMeEnabled

Управляет отображением флажка Remember 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

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

cuba.web.showFolderIcons

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

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

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

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

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

Интерфейс: WebConfig

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

cuba.web.requirePasswordForNewUsers

Если значение установлено в true, то пароль является обязательным полем при создании пользователя из Web Client. Рекомендуется устанавливаеть значение false, если в приложении используется LDAP аутентификация.

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

Интерфейс: WebAuthConfig

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

cuba.web.standardAuthenticationUsers

Разделенный запятыми список логинов пользователей, которые могут входить в систему, используя только стандартную аутентификацию. Для этих пользователей внешняя аутентификация (например, LDAP или IDP SSO) запрещена.

Пустой список означает, что все могут использовать внешнюю аутентификацию, если она включена.

Значение по умолчанию: <empty list>

Интерфейс: WebAuthConfig

Используется в блоке 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.

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

Интерфейс: WebConfig

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

cuba.web.uiHeartbeatIntervalSec

Задаёт интервал heartbeat-сообщений для UI веб клиента. По умолчанию будет использовано вычисляемое значение свойства cuba.httpSessionExpirationTimeoutSec / 3.

Значение по умолчанию: таймаут бездействия HTTP-сессии, сек. / 3

Интерфейс: 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 = font-icon:FILE_O

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

Интерфейс: WebConfig

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

cuba.web.useInverseHeader

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

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

$v-support-inverse-menu: false;

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

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

Интерфейс: WebConfig

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

cuba.web.userCanChooseDefaultScreen

Определяет, может ли пользователь установить для себя окно по умолчанию. Если false, поле Default screen в экране Settings будет доступно только для чтения.

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

Интерфейс: WebConfig

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

cuba.web.viewFileExtensions

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

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

Интерфейс: 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