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
| Property | Description | Default value |
|---|---|---|
| enable-latest-form-definition-lookup | Enable 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 version | false |
| default-header-config | Defines the default header config for custom case views | sm |
| default-date-format | Defines the default date format for the application | - |
| default-number-format | Defines the default number format for the application | - |
| default-dialog-size | Defines the default dialog size of the forms | - |
Properties with the prefix flowable.inspect
| Property | Description | Default value |
|---|---|---|
| enabled | Enables Flowable Inspect provided the Inspect dependencies are on the classpath and an appropriate License is configured | false |
Properties with the prefix flowable.webdav
| Property | Description | Default value |
|---|---|---|
| enabled | Enables the WebDAV integration | false |
Properties with the prefix flowable.security
| Property | Description | Default value |
|---|---|---|
| impersonate.allowed | Controls the availability of the impersonation feature, which can be useful in testing environments but dangerous in production | false |
Properties with the prefix flowable.security.oauth2
| Property | Description | Default value |
|---|---|---|
| post-logout-redirect-url | The post logout redirect URL. | - |
Properties with the prefix flowable.security.oauth2.current-user
| Property | Description | Default value |
|---|---|---|
| first-name-attribute | The name of the attribute in which the first name is located. | given_name |
| last-name-attribute | The name of the attribute in which the last name is located. | family_name |
| display-name-attribute | The name of the attribute in which the display name is located. | name |
| email-attribute | The name of the attribute in which the email is located. |
Properties with the prefix flowable.platform.idm
| Property | Description | Default value |
|---|---|---|
| service-type | Currently 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
| Property | Description | Default value |
|---|---|---|
| authorities-attributes | A comma separated list of the names of the attributes from which authorities should be extracted from without any changes. | - |
| groups-attributes | A comma separated list of the names of the attributes from which groups should be extracted from without any changes. | - |
| tenant-attribute | The name of the attribute that holds the tenant id for the authentication. | - |
| load-authorities-from-identity-service | If 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-attributes | Defines 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-mappings | Sorted list of mappings with groupKey and corresponding userDefinitionKey to be used in case there is no userDefinitionKey set. | - |
Properties with the prefix flowable.http
| Property | Description | Default value |
|---|---|---|
| client-type | The 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-properties | Whether to use system properties (e.g. http.proxyPort). Only applicable for the Apache HTTP Clients | true |
| connect-timeout | The time to live of the connection. i.e. How long should the server keep the connection alive in absence of data from the client | 5s |
| socket-timeout | The timeout until arrival of a response from the client | 5s |
| connection-request-timeout | The connection lease request timeout for connections from the connection manager. Only applicable for the Apache HTTP Clients | 5s |
| request-retry-limit | The amount of times that the request should be retried (in case of a retryable HTTP status code). Only applicable for the Apache HTTP Clients | 3 |
| disable-cert-verify | Whether to disable certificate validation | false |
Properties with the prefix info
| Property | Description | Default value |
|---|---|---|
| env.name | When 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
| Property | Description | Default value |
|---|---|---|
| title | Defines the title of your pages in the browser. | Flowable Work |
| notificationLogoUrl | Defines the path to the logo to use for in-browser notifications. | (empty) |
| engageReadOnlyTags | Chat 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 property | Description | Default value |
|---|---|---|
| labs | Enables the Features menu option, where you can change available application features on runtime. | false |
| logout | Controls the visibility of the logout button and can be set to false when using single sign-on. | true |
| enableCollapsibleSwitcher | Controls the behavior of the main left menu. | false |
| topNavigationBar | Controls the visibility of a top navigation bar with the user information (instead of it being in the main left menu). | false |
| formBasedLogout | Wether 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
| Property | Description | Default value |
|---|---|---|
| host | The host of the mail server | localhost |
| port | The port of the mail server | 1025 |
| ssl-port | The SSL port of the mail server | 1465 |
| username | The username for the mail server authentication. If empty no authentication is used | (Empty) |
| password | The password for the mail server authentication. If empty no authentication is used | (Empty) |
| default-from | The default from address that needs to be used when sending emails | flowable@localhost |
| force-to | Send 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-charset | The default charset to use when not set in the mail task | UTF-8 |
| use-ssl | Use SSL/TLS encryption. Use SMPTS/POPS | false |
| use-tls | Use STARTTLS encryption. | false |
Content Properties
Properties with the prefix flowable.content
| Property | Description | Default value |
|---|---|---|
| allowed-file-upload-suffixes | File extensions that are allowed for all uploads. If none are provided, all are allowed | (Empty) |
| allowed-file-upload-media-types | Mime types that are allowed to be uploaded for all uploads. If none are provided, all are allowed | (Empty) |
Note: both suffixes and media types are checked independently, you can set one value and leave the other empty.
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).
| Property | Description | Default value |
|---|---|---|
| Apps and pages definitions | flowable.app.definition-cache-limit | 50 |
| Case definitions | flowable.cmmn.definition-cache-limit | 100 |
| Process definitions | flowable.process.definition-cache-limit | 200 |
| Form definitions | flowable.form.definition-cache-limit | 1000 |
| Dmn definitions | flowable.dmn.definition-cache-limit | 200 |
| Content definitions | flowable.content.definition-cache-limit | 500 |
| Event definitions | flowable.eventregistry.definition-cache-limit | 200 |
| User and user account definitions | flowable.platform.idm.definition-cache-limit | 100 |
| Action definitions | flowable.action.definition-cache-limit | 200 |
| Data object definitions | flowable.dataobject.definition-cache-limit | 500 |
| Data dictionary, query, sequence and variable extractor definitions | flowable.platform.definition-cache-limit | 500 |
| Policy definitions | flowable.policy.definition-cache-limit | 100 |
| Service registry definitions | flowable.service-registry.definition-cache-limit | 200 |
| Template and template variation definitions | flowable.template.definition-cache-limit | 1000 |