This appendix describes all available application properties in alphabetical order.
- cuba.allowQueryFromSelected
-
Allows the generic filter to use sequential filtering mode. See also Section 4.2.6.10.2, “Sequential Queries”.
Default value:
true
Interface:
GlobalConfig
Used in the Web Client and the Middleware blocks.
- cuba.allowSetNotLoadedAttributes
-
Allows invoking setters for unloaded attributes of Detached entities. For more information, see Section 4.2.3, “Views”.
Default value:
false
Used in all application blocks.
- cuba.automaticDatabaseUpdate
-
Determines whether server should run DB update scripts at application start.
Default value:
false
Interface:
ServerConfig
Used in the Middleware block.
- cuba.availableLocales
-
List of supported user interface languages.
Property format:
{language_name1}|{language_code_1};{language_name2}|{language_code_2};
...Example:
cuba.availableLocales=French|fr;English|en
{language_name}
– name displayed in the list of available languages. For example, such lists can be found on the login screen and on the user edit screen.{language_code}
– corresponds to language code returned by theLocale.getLanguage()
method. Used as a suffix for message pack file names. For example,messages_fr.properties
.The first language listed in the cuba.availableLocales property, will be selected in the list of available languages by default, if the list does not contain the user’s operating system language. Otherwise, user’s operating system language will be selected by default.
Default value:
English|en;Russian|ru;French|fr
Interface:
GlobalConfig
Used in all standard blocks.
- cuba.backgroundWorker.maxActiveTasksCount
-
The maximum number of active background tasks.
Default value:
100
Interface:
WebConfig
Used in the Web Client block.
- cuba.backgroundWorker.maxClientLatencySeconds
-
Delay in seconds added to the timeout of the background task, after which the task is interrupted by the
WatchDog
mechanism. This delay compensates for the possible network latencies while polling task status.Default value:
60
Interface:
WebConfig
Used in the Web Client block.
- cuba.backgroundWorker.uiCheckInterval
-
Background task status polling interval.
Default value:
2000
Interface:
WebConfig
Used in the Web Client block.
- cuba.client.maxUploadSizeMb
-
Maximum file size (in megabytes) that can be uploaded using the FileUploadField and FileMiltiUploadField components.
Default value:
20
Interface:
ClientConfig
Used in the Web Client and the Desktop Client blocks.
- cuba.confDir
-
Defines location of the configuration folder for an application block.
Default value for the Middleware, Web Client and Web Portal blocks:
${catalina.home}/conf/${cuba.webContextName}
In case of a standard Tomcat deployment, this points to a sub-folder with the name of the current web app in the
tomcat/conf
folder, for example,tomcat/conf/app-core
.Default value for the Desktop Client block:
${cuba.desktop.home}/conf
.Interface:
GlobalConfig
Used in all standard blocks.
- cuba.cluster.enabled
-
Enables interaction between Middleware servers in a cluster. See Section 6.3.2.2, “Configuring Interaction between Middleware Servers” for details.
Default value:
false
Used in the Middleware block.
- cuba.connectionReadTimeout
-
Sets Middleware connection timeout for client blocks. Non-negative value is passed to the
setReadTimeout()
method ofURLConnection
.See also cuba.connectionTimeout.
Default value:
-1
Used in the Web Client, Web Portal and Desktop Client blocks.
- cuba.connectionTimeout
-
Sets Middleware connection timeout for client blocks. Non-negative value is passed to the
setConnectTimeout()
method ofURLConnection
.See also cuba.connectionReadTimeout.
Default value:
-1
Used in the Web Client, Web Portal and Desktop Client blocks.
- cuba.connectionUrlList
-
Sets Middleware server connection URL for client blocks.
Property value should contain one or more comma separated URLs
http[s]://host[:port]/app-core
, wherehost
is the server hostname,port
is the server port, andapp-core
is the name of the the Middleware block web application. For example:cuba.connectionUrlList = http://localhost:8080/app-core
When using a cluster of Middleware servers, their addresses should be listed, separated with commas:
cuba.connectionUrlList = http://server1:8080/app-core,http://server2:8080/app-core
The order of servers in the list, determines the order in which the client will attempt to send requests. In the example above, the client will send request to
server1
first, and if it is inaccessible, toserver2
. If a request toserver2
completes successfully, the client will useserver2
as the primary server and will continue working with it. Restarting the client will reset the list to the initial value. Uniform distribution of clients across a cluster of servers can be achieved by using the cuba.randomServerPriority property.See also cuba.useLocalServiceInvocation.
Interface:
ClientConfig
Used in the Web Client, Web Portal and Desktop Client blocks.
- cuba.creditsConfig
-
Defines a set of
credits.xml
files containing information about the software components used by the application.Property value should contain a list of file names separated with spaces. Resources interface rules apply to loading files.
Used in the Web Client and the Desktop Client blocks.
Example:
cuba.creditsConfig = cuba-credits.xml reports-credits.xml credits.xml
- cuba.dataSourceJndiName
-
Defines JNDI name of the
javax.sql.DataSource
object used for connection to the application database.Default value:
java:comp/env/jdbc/CubaDS
Used in the Middleware block.
- cuba.dataDir
-
Defines the location of the work folder for an application block.
Default value for the Middleware, Web Client and Web Portal blocks:
${catalina.home}/work/${cuba.webContextName}
In case of a standard Tomcat deployment, this points to a sub-folder with the name of the current web-app inside the
tomcat/work
folder, for example,tomcat/work/app-core
.Default value for the Desktop Client block:
${cuba.desktop.home}/work
.Interface:
GlobalConfig
Used in all standard blocks.
- cuba.dbDir
-
Defines the location of the database scripts folder.
Default value:
${catalina.home}/webapps/${cuba.webContextName}/WEB-INF/db
, which points to theWEB-INF/db
sub-folder of the current web-app folder in Tomcat.Interface:
ServerConfig
Used in the Middleware block.
- cuba.dbmsType
-
Defines the DBMS type. Affects the choice of DBMS integration interface implementations and the search for database init and update scripts together with cuba.dbmsVersion.
See Section 4.3.1, “DBMS Types” for details.
Default value:
hsql
Used in the Middleware block.
- cuba.dbmsVersion
-
An optional property that sets the database version. Affects the choice of DBMS integration interface implementations and the search for database init and update scripts together with cuba.dbmsType.
See Section 4.3.1, “DBMS Types” for details.
Default value:
none
Used in the Middleware block.
- cuba.defaultQueryTimeoutSec
-
Defines default transaction timeout.
Default value:
0
(no timeout).Interface:
ServerConfig
Used in the Middleware block.
- cuba.desktop.useServerTime
-
Enables adjustment of the time provided by the TimeSource interface of the Desktop Client block.The time will approximately equal to the time of the Middleware the client is connected to.
Default value:
true
Interface:
DesktopConfig
Used in the Desktop Client block.
- cuba.desktop.useServerTimeZone
-
Enables adjustment of the Desktop Client block’s JVM timezone to the timezone of the Middleware the client is connected to.
Default value:
true
Interface:
DesktopConfig
Used in the Desktop Client block.
- cuba.disableOrmXmlGeneration
-
Prohibits automatic generation of the
orm.xml
file for extended entities. Allows creating and registering this file manually in theopenjpa.MetaDataFactory
parameter of the persistence.xml file.Default value:
false
(orm.xml
will be created automatically if any extended entity exist).Used in the Middleware block.
- cuba.dispatcherSpringContextConfig
-
Defines a set of dispatcher-spring.xml files in the client blocks.
The value of the property should contain a list of file names separated with spaces. Resources interface rules apply to loading files.
Used in the Web Client and Web Portal blocks.
Example:
cuba.dispatcherSpringContextConfig = cuba-portal-dispatcher-spring.xml portal-dispatcher-spring.xml
- cuba.download.directories
-
Defines a list of folders from which the Middleware files can be downloaded from via
com.haulmont.cuba.core.controllers.FileDownloadController
. For example, file downloading is utilized by the server log display mechanism found in the > web client screen.The folder list should be separated with semicolon.
Default value:
${cuba.tempDir};${cuba.logDir}
(files can be downloaded from the temporary folder and the logs folder).Used in the Middleware block.
- cuba.email.*
-
Email sending parameters described in Section 4.7.2.3, “Configuring Email Sending Parameters”.
- cuba.fileStorageDir
-
Defines file storage folder structure roots. For more information, see Section 4.7.8.3, “Standard File Storage Implementation”.
Default value:
null
Used in the Middleware block.
- cuba.gui.genericFilterChecking
-
Influences the behavior of the Filter component.
When set to
true
, does not allow to apply a filter without specifying parameters.Default value:
false
Interface:
ClientConfig
Used in the Web Client and Desktop Client blocks.
- cuba.gui.genericFilterControlsLayout
-
Sets a template for Filter controls layout. Each control has the following format:
[component_name | options-comma-separated]
, e.g.[pin | no-caption, no-icon]
.Available controls:
-
filters_popup
- popup button for selecting a filter, combined with the button. -
filters_lookup
- lookup field for selecting a filter. The button should be added as a separate control. -
search
- button. Do not add if usefilters_popup
. -
add_condition
- link button for adding new conditions. -
spacer
- an empty space between controls. -
settings
- button. Specify action names that should be displayed in Settings popup as options (see below). -
max_results
- group of controls for setting maximum number of records to be selected. -
fts_switch
- checkbox for switching to the Full-Text Seacrh mode.
The following actions can be used as options of the
settings
control:save
,save_as
,edit
,remove
,pin
,make_default
,save_search_folder
,save_app_folder
.The actions can also be used as independent controls outside of the Settings popup. In this case, they can have the following options:
-
no-icon
- if an action button should be dispalyed without an icon. For example:[save | no-icon]
. -
no-caption
- if an action button should be dispalyed without a caption. For example:[pin | no-caption]
.
Default value:
[filters_popup] [add_condition] [spacer] \ [settings | save, save_as, edit, remove, make_default, pin, save_search_folder, save_app_folder] \ [max_results] [fts_switch]
Interface:
ClientConfig
Used in the Web Client and Desktop Client blocks.
-
- cuba.gui.genericFilterManualApplyRequired
-
Influences the behavior of the Filter component.
When set to
true
, the screens containing filters will not load the corresponding datasources automatically, until user clicks the filter button.The value of cuba.gui.genericFilterManualApplyRequired is ignored, when opening browser screens using an application or search folders, i.e. the filter is applied. The filter will not be applied, if the
applyDefault
value for a folder is explicitly set tofalse
.Default value:
false
Interface:
ClientConfig
Used in the Web Client and Desktop Client blocks.
- cuba.gui.genericFilterColumnsQty
-
Defines the number of columns with conditions for the Filter component.
Default value:
3
Interface:
ClientConfig
Used in the Web Client and Desktop Client blocks.
- cuba.gui.genericFilterConditionsLocation
-
Defines the location of the conditions panel in the Filter component. Two locations are available:
top
(above the filter control elements) andbottom
(below the filter control elements).Default value:
top
Interface:
ClientConfig
Used in the Web Client and Desktop Client blocks.
- cuba.gui.genericFilterPopupListSize
-
Defines the number of items displayed in the popup list of the
button. If the number of filters exceeds this value, action is added to the popup list. The action opens a new dialog window with a list of all possible filters.Default value:
10
Interface:
ClientConfig
Used in the Web Client and Desktop Client blocks.
- cuba.groovyEvaluationPoolMaxIdle
-
Sets the maximum number of unused compiled Groovy expressions in the pool during
Scripting.evaluateGroovy()
method execution. It is recommended to increment this parameter when intensive execution of Groovy expressions is required, for example, for a large number of application folders.Default value: 8
Used in all standard blocks.
- cuba.groovyEvaluatorImport
-
Defines a list of classes imported by all Groovy expressions executed through Scripting.
Class names in the list should be separated with commas or semicolons.
Default value:
com.haulmont.cuba.core.global.PersistenceHelper
Used in all standard blocks.
Example:
cuba.groovyEvaluatorImport = com.haulmont.cuba.core.global.PersistenceHelper,com.abc.sales.CommonUtils
- cuba.gui.useSaveConfirmation
-
Defines the layout of the dialog displayed when a user attempts closing a screen with unsaved changes in datasources.
Value of
true
corresponds to a layout with three possible actions: Save changes, Don’t Save, Don’t close the screen.The value of
false
corresponds to a form with two options: Close the screen without saving changes, Don’t close the screen.Default value:
true
Interface:
ClientConfig
Used in the Web Client and Desktop Client blocks.
- cuba.httpSessionExpirationTimeoutSec
-
Defines HTTP-session inactivity timeout in seconds.
Default value:
1800
Interface:
WebConfig
Used in the Web Client block.
It is recommended to use the same values for cuba.userSessionExpirationTimeoutSec and
cuba.httpSessionExpirationTimeoutSec
properties. - cuba.inMemoryDistinct
-
Enables in-memory filtering of duplicate records instead of using
select distinct
at the database level. Used by the DataManager.Default value:
false
Interface:
ServerConfig
Used in the Middleware block.
- cuba.jmxUserLogin
-
Defines a user login that should be used for system authentication.
Default value:
admin
Used in the Middleware block.
- cuba.licensePath
-
Path to the CUBA platform license file. Resources interface rules apply to loading files. See also Section 6.6, “License File Usage”.
Default value:
/cuba.license
Interface:
ServerConfig
Used in the Middleware block.
- cuba.localeSelectVisible
-
Disables the user interface language selection when logging in.
If
cuba.localeSelectVisible
is set to false, the locale for a user session is selected in the following way:-
If the
User
entity instance has alanguage
attribute defined, the system will use this language. -
If the user’s operating system language is included in the list of available locales (set by the cuba.availableLocales property), the system will use this language.
-
Otherwise, the system will use the first language defined in the cuba.availableLocales property.
Default value:
true
Interface:
GlobalConfig
Used in all standard blocks.
-
- cuba.logDir
-
Defines the location of the log folder for an application block.
Default value for the Middleware, Web Client and Web Portal blocks:
${catalina.home}/logs
In case of a standard Tomcat deployment, this property points to the
tomcat/logs
folder.Default value for the Desktop Client block:
${cuba.desktop.home}/logs
.Interface:
GlobalConfig
Used in all standard blocks.
- cuba.mainMessagePack
-
Defines the main message pack for an application block.
The value may include a single pack or a list of packs separated with spaces.
Used in all standard blocks.
Example:
cuba.mainMessagePack = com.haulmont.cuba.web com.sample.sales.web
- cuba.manualScreenSettingsSaving
-
If the property is set to
true
, screens will not save their settings automatically on close. In this mode, a user can save or reset settings using the context menu which appears on clicking a screen tab or a dialog window caption.Default value:
false
Interface:
ClientConfig
Used in the Web Client and Desktop Client blocks.
- cuba.menuConfig
-
Defines a set of menu.xml files.
The property value should be a list of files separated with spaces. Resources interface rules apply to loading files.
Used in the Web Client and Desktop Client blocks.
Example:
cuba.menuConfig = cuba-web-menu.xml web-menu.xml
- cuba.metadataConfig
-
Defines a set of metadata.xml files.
The property value should be a list of files separated with spaces. Resources interface rules apply to loading files.
Used in the Middleware, Web Client and Desktop Client.
Example:
cuba.metadataConfig = cuba-metadata.xml metadata.xml
- cuba.passwordEncryptionModule
-
Defines the name of the bean used for user password hashing.
Default value:
cuba_Sha1EncryptionModule
Used in all standard blocks.
- cuba.passwordPolicyEnabled
-
Enables password policy enforcement. If the property is set to
true
, all new user passwords will be checked according to the cuba.passwordPolicyRegExp property.Default value:
false
Interface:
ClientConfig
Used in the client blocks: Web Client, Web Portal, Desktop Client.
- cuba.passwordPolicyRegExp
-
Defines a regular expression used by the password checking policy.
Default value:
((?=.*\\d)(?=.*\\p{javaLowerCase}) (?=.*\\p{javaUpperCase}).{6,20})
The expression above ensures that password contains from 6 to 20 characters, uses numbers and Latin letters, contains at least one number, one lower case and one upper case letter. More information on regular expression syntax is available at https://en.wikipedia.org/wiki/Regular_expression and http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html.
Interface:
ClientConfig
Used in the client level blocks: Web Client, Web Portal, Desktop Client.
- cuba.permissionConfig
-
Defines a set of permissions.xml files.
Used in the Web Client and Desktop Client blocks.
Example:
cuba.permissionConfig = cuba-web-permissions.xml web-permissions.xml
- cuba.persistenceConfig
-
Defines a set of persistence.xml files.
The property value should be a list of files separated with spaces. Resources interface rules apply to loading files.
Used in the Middleware, Web Client and Desktop Client.
Example:
cuba.persistenceConfig = cuba-persistence.xml persistence.xml
- cuba.portal.anonymousUserLogin
-
Defines a user login that should be used for anonymous session in the Web Portal block.
The user with the specified login should exist in the security subsystem and should have the required permissions. User password is not required, because anonymous portal sessions are created via the loginTrusted() method with the password defined in the cuba.trustedClientPassword property.
Interface:
PortalConfig
Used in the Web Portal block.
- cuba.randomServerPriority
-
Enables random selection of a Middleware server to connect to in a cluster, to ensure uniform distribution of clients between servers.
See also the cuba.connectionUrlList property.
Default value:
false
Used in the Web Client, Web Portal, Desktop Client blocks.
- cuba.remotingSpringContextConfig
-
Defines a set of remoting-spring.xml files in the Middleware block.
The property value should be a list of files separated with spaces. Resources interface rules apply to loading files.
Used in the Middleware block.
Example:
cuba.remotingSpringContextConfig = cuba-remoting-spring.xml remoting-spring.xml
- cuba.rest.productionMode
-
Activates the REST API production mode that does not return exception text to client.
Interface:
RestConfig
Used in the Web Portal block.
Default value:
false
- cuba.rest.apiVersion
-
Defines the REST API version. If the value is set to
1
, the REST API of the platform versions before 5.4 is used. Setting the value to2
enables the new REST API version with support for service calls.Interface:
RestConfig
Used in the Web Portal block.
Default value:
2
- cuba.restApiUrl
-
URL to the application’s REST API.
Interface:
GlobalConfig
Can be used in all standard blocks.
Default value:
http://localhost:8080/app-portal/api
- cuba.restServicesConfig
-
This configuration parameter defines a set of files that contains a list of services available for application REST API calls.
The value is a list of file names, separated by spaces. The files are loaded according to the Resources interface rules.
The XSD of the file is available at
http://schemas.haulmont.com/cuba/5.6/restapi-service-v2.xsd
.Used in the Web Portal block.
Default value:
cuba-rest-services.xml
Example:
cuba.restServicesConfig = cuba-rest-services.xml app-rest-services.xml
- cuba.schedulingActive
-
Enables the CUBA scheduled tasks mechanism.
Default value:
false
Interface:
ServerConfig
Used in the Middleware block.
- cuba.springContextConfig
-
Defines a set of spring.xml files in an application block.
The property value should be a list of file names separated with spaces. Resources interface rules apply to loading files.
Used in all standard blocks.
Example:
cuba.springContextConfig = cuba-spring.xml spring.xml
- cuba.supportEmail
-
Specifies an email address to which exception reports from the default exception handler screen, as well as user messages from the
> screen will be sent.button in the exception handler screen will be hidden, if this property is set to an empty string.
In order to successfully send emails, the parameters described in Section 4.7.2.3, “Configuring Email Sending Parameters” must also be configured.
Interface:
WebConfig
Used in the Web Client block.
- cuba.systemInfoScriptsEnabled
-
Enables the display of SQL-scripts for creating / updating / retrieving an entity instance in the System Information window.
Such scripts actually show the contents of the database rows that store the selected entity instance, regardless of security settings that may deny viewing of some attributes. That is why it is reasonable to revoke the
CUBA / Generic UI / System Information
specific permission for all user roles except the administrators, or set thecuba.systemInfoScriptsEnabled
tofalse
for the whole application.Default value:
true
Interface:
ClientConfig
Used in the Web Client and the Desktop Client blocks.
- cuba.tempDir
-
Defines the location of the temporary directory for an application block.
The default value for the Middleware, Web Client, Web Portal blocks:
${catalina.home}/temp/${cuba.webContextName}
In case of a standard Tomcat deployment, this points to a sub-folder with the name of the current web-app in the
tomcat/temp
folder, for example,tomcat/temp/app-core
.The default value for the Desktop Client block:
${cuba.desktop.home}/temp
.Interface:
GlobalConfig
Used in all standard blocks.
- cuba.triggerFilesCheck
-
Enables the processing of bean invocation trigger files.
The trigger file is a file that is placed in the
triggers
subdirectory of the application block’s temporary directory. The trigger file name consists of two parts separated with a period. The first part is the bean name, the second part is the method name of the bean to invoke. For example:cuba_Messages.clearCache
. The trigger files handler monitors the folder for new trigger files, invokes the appropriate methods and then removes the files.By default, the trigger files processing is configured in the
cuba-web-spring.xml
file and performed for the Web Client block only. At the project level, the processing for other modules can be performed by periodically invoking theprocess()
method of thecuba_TriggerFilesProcessor
bean.Default value:
true
Used in blocks with the configured processing, default is Web Client.
- cuba.themeConfig
-
Defines a set of
*-theme.properties
files that store theme variables, such as default popup window dimensions and input field width.The property takes a list of files separated by spaces. The files are loaded as defined by the Resources interface.
Default value for Web Client:
havana-theme.properties halo-theme.properties
Default value for Desktop Client:
nimbus-theme.properties
Used in the Web Client and Desktop Client block.
- cuba.trustedClientPassword
-
Defines password used by the
LoginService.loginTrusted()
method. The Middleware layer can authenticate users who connect via the trusted client block without checking the user password.This property is used when user passwords are not stored in the database, while the client block performs the actual authentication itself. For example, by integrating with Active Directory.
Interfaces:
ServerConfig
,WebConfig
Used in blocks: Middleware, Web Client, Web Portal.
- cuba.trustedClientPermittedIpMask
-
Defines IP address mask in form of regular expression, to which the invocation of the
LoginService.loginTrusted()
method is allowed.Default value:
127\.0\.0\.1
Interfaces:
ServerConfig
,WebConfig
Used in blocks: Middleware, Web Client, Web Portal.
- cuba.uniqueConstraintViolationPattern
-
A regular expression which is used to find out that the exception is caused by a database unique constraint violation. The first or second group of the expression must return the constraint name. For example:
ERROR: duplicate key value violates unique constraint "(.+)"
The constraint name can be used to display a localized message that indicates what entity is concerned. For this the main message pack should contain keys equal to constraint names. For example:
IDX_SEC_USER_UNIQ_LOGIN = A user with the same login already exists
This property allows you to define a reaction to unique constraint violations depending on DBMS locale and version.
Default value is returned by the
PersistenceManagerService.getUniqueConstraintViolationPattern()
method for the current DBMS.Used in all client blocks.
- cuba.useCurrentTxForConfigEntityLoad
-
Enables using current transaction, if there is one at the moment, for loading entity instances via the configuration interfaces. This could have a positive impact on performance. Otherwise, a new transaction is always created and committed, and the detached instances are returned.
Default value:
false
Used in the Middleware block.
- cuba.useLocalServiceInvocation
-
When set to
true
, and Tomcat fast deployment is used, the Web Client and Web Portal blocks invoke the Middleware services locally, bypassing the network stack, which has a positive impact on system performance. This property should be set to false for all other deployment options.Default value:
false
Used in the Web Client and Web Portal blocks.
- cuba.user.fullNamePattern
-
Defines the full name pattern for user.
Default value:
{FF| }{LL}
The full name pattern can be formed from the user’s first, last and middle names. The following rules apply to the pattern:
-
The pattern parts are separated by
{}
-
The pattern inside
{}
must contain one of the following characters followed by the|
character without any spaces:LL
– long form of user’s last name (Smith)L
– short form of user’s last name (S)FF
– long form of user’s first name (John)F
– short form of user’s first name (J)MM
– long form of user’s middle name (Paul)M
– short form of user’s middle name (P) -
The
|
character can be followed by any symbols including spaces.
Used in the Web Client and Desktop Client blocks.
-
- cuba.user.namePattern
-
Defines the display name pattern for the
User
entity. The display name is used in different places, including the upper right corner of the system’s main window.Default value:
{1} [{0}]
{0}
is substituted with thelogin
attribute,{1}
– with thename
attribute.Used in the Middleware, Web Client and Desktop Client blocks.
- cuba.userSessionExpirationTimeoutSec
-
Defines the user session expiration timeout in seconds.
Default value:
1800
Interface:
ServerConfig
Used in the Middleware block.
It is recommended to use the same values for cuba.userSessionExpirationTimeoutSec and cuba.httpSessionExpirationTimeoutSec.
- cuba.userSessionProviderUrl
-
Defines the Middleware block URL used for logging users in.
This parameter should be set in additional middleware blocks that execute client requests, but do not share the user session cache. If there is no required session in the local cache at the start of the request, this block invokes the
LoginService.getSession()
method at the specified URL, and caches the retrieved session.Interface:
ServerConfig
Used in the Middleware block.
- cuba.viewsConfig
-
Defines a list of the views.xml files, automatically deployed during startup of the application. See Section 4.2.3, “Views”.
Used in all standard blocks.
Example:
cuba.viewsConfig = cuba-views.xml reports-views.xml views.xml
- cuba.webAppUrl
-
Defines URL of the Web Client application.
In particular, used to generate external application screen links, as well as by the
ScreenHistorySupport
class.Interface:
GlobalConfig
Can be used in all standard blocks.
Default value:
http://localhost:8080/app
- cuba.windowConfig
-
Defines a list of the screens.xml files.
The property value should contain a list of file names separated with spaces. Resources interface rules apply to loading files.
Used in the Web Client and Desktop Client blocks.
Example:
cuba.windowConfig = cuba-web-screens.xml web-screens.xml
- cuba.web.allowHandleBrowserHistoryBack
-
Enables handling of browser
button in the application by overridingAppWindow.onHistoryBackPerformed()
. If the property is true, the standard browser behavior is replaced with this method invocation.See Section 4.5.8, “Web Client Specifics”.
Default value:
true
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.appFoldersRefreshPeriodSec
-
Defines application folders refresh period in seconds.
Default value:
180
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.appWindowMode
-
Determines the initial mode for the main application window – tabbed or single screen (
TABBED
orSINGLE
respectively). In single screen mode, screens opened in theNEW_TAB
mode will replace the current screen, instead of opening a new tab. This can be useful for simple applications and inexperienced users.The user is able to change the mode later, using the
> screen.Default value:
TABBED
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.foldersPaneDefaultWidth
-
Defines default width (in pixels) for the folders panel.
Default value:
200
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.foldersPaneEnabled
-
Enables the folders panel functionality.
Default value:
true
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.foldersPaneVisibleByDefault
-
Determines whether the folders panel should be expanded by default.
Default value:
false
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.linkHandlerActions
-
Defines a list of URL commands handled by the
LinkHandler
bean. See Section 4.7.13, “Screen Links” for more information.The elements should be separated with the
|
character.Default value:
open|o
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.loginDialogDefaultUser
-
Defines default user name, which will be automatically populated in the login screen. This is very convenient during development. This property should be set to
<disabled>
value in production environment.Default value:
admin
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.loginDialogDefaultPassword
-
Defines default user password, which will be automatically populated in the login screen. This is very convenient during development. This property should be set to
<disabled>
value in production environment.Default value:
admin
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.maxTabCount
-
Defines the maximum number of tabs that can be opened in the main application window. The value of
0
disables this limitation.Default value:
7
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.rememberMeEnabled
-
Enables displaying Remember Me checkbox in the standard login screen of the web client.
Default value:
true
Interface:
WebConfig
Used in Web Client.
- cuba.web.resourcesRoot
-
Sets a directory for loading files to display by Embedded component. For example:
cuba.web.resourcesRoot = ${cuba.confDir}/resources
Default value:
null
Interface:
WebConfig
Used in Web Client.
- cuba.web.showBreadCrumbs
-
Enables hiding of the breadcrumbs panel which normally appears on top of the main window working area.
Default value:
true
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.showFolderIcons
-
Enables the folders panel icons. When enabled, the following application theme files are used:
-
icons/app-folder-small.png
– for application folders. -
icons/search-folder-small.png
– for search folders. -
icons/set-small.png
– for record sets.
Default value:
false
Interface:
WebConfig
Used in the Web Client block.
-
- cuba.web.table.cacheRate
-
Adjusts Table caching in the web browser. The amount of cached rows will be
cacheRate
multiplied with pageLength both below and above visible area.Default value:
2
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.table.pageLength
-
Sets the number of rows to be fetched from the server into the web browser when Table is rendered first time on refresh. See also cuba.web.table.cacheRate.
Default value:
15
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.theme
-
Defines the name of the theme used as default for the web client. See also cuba.themeConfig.
Default value:
havana
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.useFontIcons
-
If this property is enabled for Halo theme, Font Awesome glyphs will be used for standard actions and platform screens instead of images.
The correspondence between the name in the icon attribute of a visual component or action and font element is defined in the
halo-theme.properties
file of the platform. Keys withcuba.web.icons
prefixes correspond to icon names, and their values - tocom.vaadin.server.FontAwesome
enumeration constants. For example, a font element for the standardcreate
action is defined as follows:cuba.web.icons.create.png = FILE_O
Default value:
true
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.useInverseHeader
-
Controls the web client application header for Halo theme and its inheritors. If
true
, the header will be dark (inverse), iffalse
- the header takes the colour of the main application background.This property is ignored in case
$v-support-inverse-menu: false;
property is set in the application theme. This makes sense for a dark theme, if the user has the option to choose between a light and a dark theme. In this case, the header will be inverse for the light theme, and the same as the main background in the dark theme.
Default value:
true
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.useLightHeader
-
Enables the compact version of the upper part of the main application window – logo, menu bar, user name and logout button will be placed in single line. When disabled,
AppWindow.createTitleLayout()
creates additional area at the top.Default value:
true
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.viewFileExtensions
-
Defines a list of file extensions displayed in the browser when downloading the file using
ExportDisplay.show()
. The|
character should be used to separate the list items.Default value:
htm|html|jpg|png|jpeg|pdf
Interface:
WebConfig
Used in the Web Client block.
- cuba.web.showBreadCrumbs
-
Hides breadcrumbs (screens navigation) panel.
Default value:
true
Interface:
WebConfig
Used in the Web Client block.
- cuba.webContextName
-
Defines the web application context name. It is usually equivalent to the name of the directory or WAR-file containing this application block.
Interface:
GlobalConfig
Used in blocks: Middleware, Web Client, Web Portal.
For example, for the Middleware block, located in
tomcat/webapps/app-core
and available athttp://somehost:8080/app-core
, the property should be set to the following value:cuba.webContextName = app-core
- cuba.webHostName
-
Defines the host name of the machine, on which this application block is running.
Default value:
localhost
Interface:
GlobalConfig
Used in blocks: Middleware, Web Client, Web Portal.
For example, for the Middleware block, available at
http://somehost:8080/app-core
, the property should be set to the following value:cuba.webHostName = somehost
- cuba.webPort
-
Defines the port, on which this application block is running.
Default value:
8080
Interface:
GlobalConfig
Used in blocks: Middleware, Web Client, Web Portal.
For example, for the Middleware block, available at
http://somehost:8080/app-core
, this property should be set to the following value:cuba.webPort = 8080