Skip to main content

Flowable Work Properties

Properties

Work is a Spring Boot application. This means that it is configured as a Spring Boot application and all available properties for Spring Boot application are also applicable for Work.

Work specific properties

The following list displays the properties which are specific for Work.

Properties with the prefix flowable.platform

PropertyDescriptionDefault value
enable-latest-form-definition-lookupEnable always fetching the latest form definition for any task or page. Useful during development of forms, to save the step of having to create new instances of the task to see the new form versionfalse
default-header-configDefines the default header config for custom case viewssm
default-date-formatDefines the default date format for the application-
default-number-formatDefines the default number format for the application-
default-dialog-sizeDefines the default dialog size of the forms-

Properties with the prefix flowable.inspect

PropertyDescriptionDefault value
enabledEnables Flowable Inspect provided the Inspect dependencies are on the classpath and an appropriate License is configuredfalse

Properties with the prefix flowable.webdav

PropertyDescriptionDefault value
enabledEnables the WebDAV integrationfalse

Properties with the prefix flowable.security

PropertyDescriptionDefault value
impersonate.allowedControls the availability of the impersonation feature, which can be useful in testing environments but dangerous in productionfalse

Properties with the prefix flowable.security.oauth2

PropertyDescriptionDefault value
post-logout-redirect-urlThe post logout redirect URL.-

Properties with the prefix flowable.security.oauth2.current-user

PropertyDescriptionDefault value
first-name-attributeThe name of the attribute in which the first name is located.given_name
last-name-attributeThe name of the attribute in which the last name is located.family_name
display-name-attributeThe name of the attribute in which the display name is located.name
email-attributeThe name of the attribute in which the email is located.email

Properties with the prefix flowable.platform.idm

PropertyDescriptionDefault value
service-typeCurrently two options exist: The flowable built in identity management (default) or LDAP integration (ldap).default (the built in IDM)

Properties with the prefix flowable.security.oauth2.client.mapper and flowable.security.oauth2.resourceserver.mapper

PropertyDescriptionDefault value
authorities-attributesA comma separated list of the names of the attributes from which authorities should be extracted from without any changes.-
groups-attributesA comma separated list of the names of the attributes from which groups should be extracted from without any changes.-
tenant-attributeThe name of the attribute that holds the tenant id for the authentication.-
load-authorities-from-identity-serviceIf set to true, it will load the user information (groups, authorities, features) from the identity service. This might impact performance depending on the speed of your identity service and the backed service (e.g. LDAP).false
idm-user-id-attributesDefines what claim of the token is used to indentify the user in the identity service. By default, the sub claim in the token is used to lookup a person in the configured IDM. (see flowable.platform.idm.service-type)sub
user-definition-group-mappingsSorted list of mappings with groupKey and corresponding userDefinitionKey to be used in case there is no userDefinitionKey set.-

Properties with the prefix flowable.http

PropertyDescriptionDefault value
client-typeThe type of the client that should be used. If defined then the default precedence will not come into effect. Available options are: springWebClient, apacheHttpClient5 and apacheHttpClient4
use-system-propertiesWhether to use system properties (e.g. http.proxyPort). Only applicable for the Apache HTTP Clientstrue
connect-timeoutThe time to live of the connection. i.e. How long should the server keep the connection alive in absence of data from the client5s
socket-timeoutThe timeout until arrival of a response from the client5s
connection-request-timeoutThe connection lease request timeout for connections from the connection manager. Only applicable for the Apache HTTP Clients5s
request-retry-limitThe amount of times that the request should be retried (in case of a retryable HTTP status code). Only applicable for the Apache HTTP Clients3
disable-cert-verifyWhether to disable certificate validationfalse

Properties with the prefix info

PropertyDescriptionDefault value
env.nameWhen defined, adds a small text box under the application logo on the left menu. Useful to identify the environment in which you are running, or display version information.(Empty)

Frontend properties

Properties with the prefix flowable.frontend

PropertyDescriptionDefault value
titleDefines the title of your pages in the browser.Flowable Work
notificationLogoUrlDefines the path to the logo to use for in-browser notifications.(empty)
engageReadOnlyTagsChat capabilities only: List of tags to enforce read-only conversations when present in the conversation.(empty)
endpoints.\<endpointId>Paths to the application backend endpoints to be resolved in the forms.
In order to provide custom endpoints (internal relative paths or external absolute URLs) to your forms, so that they can be used at rendering time in modelled frontend expressions, you can extend this property.
For instance, you can define flowable.frontend.endpoints.myCustomExternalApi=http://custom-api/whatever and use in your form models the expression {{endpoints.myCustomExternalApi}} which will then be resolved at rendering time to http://custom-api/whatever.
See Form Expressions

Properties with the prefix flowable.frontend.features

Feature propertyDescriptionDefault value
labsEnables the Features menu option, where you can change available application features on runtime.false
logoutControls the visibility of the logout button and can be set to false when using single sign-on.true
enableCollapsibleSwitcherControls the behavior of the main left menu.false
topNavigationBarControls the visibility of a top navigation bar with the user information (instead of it being in the main left menu).false
formBasedLogoutWether a form based logout should be used in the frontend.false

Note: properties "flowable.frontend.features.\<featureId>" can also be used to enable widely some application features which can otherwise be enabled for certain user definitions only (see the related Java Programming Extensions documentation for more details about existing feature flags).

Mail Properties

Properties with the prefix flowable.mail.server

PropertyDescriptionDefault value
hostThe host of the mail serverlocalhost
portThe port of the mail server1025
ssl-portThe SSL port of the mail server1465
usernameThe username for the mail server authentication. If empty no authentication is used(Empty)
passwordThe password for the mail server authentication. If empty no authentication is used(Empty)
default-fromThe default from address that needs to be used when sending emailsflowable@localhost
force-toSend all emails from the Email task to this address. This should only be set for testing purposes, otherwise the Email task configurations are ignored(Empty)
default-charsetThe default charset to use when not set in the mail taskUTF-8
use-sslUse SSL/TLS encryption. Use SMPTS/POPSfalse
use-tlsUse STARTTLS encryption.false

Model Cache Properties

The following properties configure how many definitions are cached in-memory. Definitions are the parsed and processed version of a model. Caching them speeds up creating instances of them.

The default values are set to a standard Flowable setup. If more models need to be cached, these values can be adapted accordingly. Also in case one app deployment contains more models of a certain type than the default value for that model type, this value needs to be made higher (there will be exceptions in the logs mentioning did not put in the cache).

PropertyDescriptionDefault value
Apps and pages definitionsflowable.app.definition-cache-limit50
Case definitionsflowable.cmmn.definition-cache-limit100
Process definitionsflowable.process.definition-cache-limit200
Form definitionsflowable.form.definition-cache-limit1000
Dmn definitionsflowable.dmn.definition-cache-limit200
Content definitionsflowable.content.definition-cache-limit500
Event definitionsflowable.eventregistry.definition-cache-limit200
User and user account definitionsflowable.platform.idm.definition-cache-limit100
Action definitionsflowable.action.definition-cache-limit200
Data object definitionsflowable.dataobject.definition-cache-limit500
Data dictionary, query, sequence and variable extractor definitionsflowable.platform.definition-cache-limit500
Policy definitionsflowable.policy.definition-cache-limit100
Service registry definitionsflowable.service-registry.definition-cache-limit200
Template and template variation definitionsflowable.template.definition-cache-limit1000