Flowable Design Properties
info
In case you are using Flowable Design 3.13 or the Angular-based Flowable Design 3.14 please check out the previous version of this list.
Design 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 Design.
Design specific properties
The following list displays the properties which are specific for Design.
General properties
Properties with the prefix flowable.design
| Property | Description | Default value |
|---|---|---|
| deployment-api-url | The root URL to the REST services of the Flowable engine that should be used for deploying applications | http://localhost:8080/flowable-work/app-api |
| undeployment-api-url | The URL to the REST endpoint of the Flowable engine that should be used for undeploying (cascade all app artefacts) | http://localhost:8080/flowable-work/platform-api/app-deployments |
| deployment-api-tenant-id | Optional tenant id value that should be used when deploying an application | |
| license-location | The location of the license file | file:${user.home}/.flowable/flowable.license |
| db-store-enabled | Whether the license should be fetched from the database | false |
| multi-tenant-enabled | Whether multi tenancy design modelling is enabled | false |
| additional-palette-locations | The additional locations for palette definitions | |
| database-schema-update | The strategy that should be used for the database update schema (possible values: drop-create, true, false, ignore) | true |
| database-schema | The database schema to be used for table checks / generation (needed in case the database metadata doesn't return that correctly) | |
| primary-language-code | The code of the primary language used for modelling | en_us |
| secondary-language-codes | The codes of the additional languages used for modelling | de_de,fr_fr,it_it,es_es |
| deployment-tenant-source | v3.15.6+ Configure a source for the deployment tenant id. | |
| form-component-development.enabled | v3.17.0+ Enable Custom Form Components development | false |
note
The available options for flowable.design.deployment-tenant-source are:
model-tenant-id- Will use the tenant id of the model that is being deployed as deployment tenant id. Note, that when using this the configured tenant id in thedeployment-api-tenantwill not be used. Theflowable.design.deployment-tenant-mapping.<source>property can be used to provide a mapping between a Design tenant and a deployment tenantmodel-workspace-key- Will use the workspace key of the model that is being deployed as deployment source for the configuredflowable.design.deployment-tenant-mapping.<source>. Note, that when using this if there is no mapping provided then the configured tenant id in thedeployment-api-tenantwill be used.
REST API properties
Properties with the prefix flowable.design.rest for configuring the REST API of Flowable Design:
| Property | Description |
|---|---|
| use-app-key-in-file-name-for-export | v3.17.9+ 2025.1.03+ Use the key of an application as file-name for the exported zip instead of the application name |
Deployment properties
Properties with the prefix flowable.design.deployment.<id> for deploying and undeploying to an additional Flowable runtime system:
| Property | Description |
|---|---|
| name | A human readable name for the target environment |
| deployment-api-url | The deployment URL of the target environment |
| undeployment-api-url | The undeployment URL of the target environment |
| deployment-api-tenant-id | The tenant to deploy to of the target environment |
Model Locking properties
Properties with the prefix flowable.design.model-locking
| Property | Description | Default value |
|---|---|---|
| enabled | Whether model locking is enabled. | false |
| auto-lock-on-create | Whether models should be auto locked when they are created. Only applicable if model locking is enabled. | true |
Security properties
Properties with the prefix flowable.design.security
Security OAuth2 properties
Properties with the prefix flowable.design.security.oauth2
| Property | Description | Default value |
|---|---|---|
| admin-authorities | A comma separated list of all the authorities which should make the user an admin | - |
| authorities-attributes | A comma separated list of the names of the attributes from which authorities should be extracted from without any changes. | - |
| tenant-attribute | The name of the attribute that holds the tenant id for the authentication. | - |
| default-tenant | The default tenant that each user should be assigned to. In case the tenant attribute has no value. | default |
| post-logout-redirect-url | The post logout redirect URL. | - |
Security OAuth2 Current User properties
Properties with the prefix flowable.design.security.oauth2.current-user
| Property | Description | Default value |
|---|---|---|
| first-name-attribute | The name of the attribute in which the first name is located (only applies when not using OIDC). | given_name |
| last-name-attribute | The name of the attribute in which the last name is located (only applies when not using OIDC). | family_name |
| display-name-attribute | The name of the attribute in which the display name is located (only applies when not using OIDC). | name |
| email-attribute | The name of the attribute in which the email is located (only applies when not using OIDC). |
Security OAuth2 Resource Server properties
Properties with the prefix flowable.design.security.oauth2.resourceserver.mapper
| Property | Description | Default value |
|---|---|---|
| admin-authorities | A comma separated list of all the authorities which should make the user an admin | - |
| authorities-attributes | A comma separated list of the names of the attributes from which authorities should be extracted from without any changes. | - |
| tenant-attribute | The name of the attribute that holds the tenant id for the authentication. | - |
| default-tenant | The default tenant that each user should be assigned to. In case the tenant attribute has no value. | default |
Properties with the prefix flowable.design.security.oauth2.resourceserver.jwt
| Property | Description | Default value |
|---|---|---|
| principal-claim-name | A comma separated list of all the authorities which should make the user an admin | - |
Security Cookie properties
Properties with the prefix flowable.design.security.cookie
| Property | Description | Default value |
|---|---|---|
| name | The name of the remember me cookie | FLOWABLE_DESIGN_REMEMBER_ME |
Tenant properties
Properties with the prefix flowable.design.tenant
| Property | Description | Default value |
|---|---|---|
| list-provider | The type of the tenant list provider (one of currentTenant, database, fixed) | currentTenant |
| fixed-tenant-ids | The fixed tenant ids. Used only when list-provider is fixed | |
| default-tenant-id | The default tenant id. Models belonging to this tenant will be shown in addition to the user tenant. |
User store properties
Properties with the prefix flowable.design.user-store
| Property | Description | Default value |
|---|---|---|
| password | The password that should be used when creating the user for the basic user store during application start if there are no users and basic user store is used. | test |
Remote properties
Properties with the prefix flowable.design.remote
| Property | Description | Default value |
|---|---|---|
| idm-url | The URL to the IDM application, used for the user info and token info REST GET calls. It's also used as a fallback for the redirect url to the login page in the UI apps. | - |
| idm-api-context-path | The context path for the IDM API. | idm-api/ |
Remote Authentication properties
Properties with the prefix flowable.design.remote.authentication
| Property | Description | Default value |
|---|---|---|
| user | The username used for executing the REST calls (with basic auth) or the client registration id (for oauth2) to the IDM REST services. | admin |
| password | The password used for executing the REST calls (with basic auth) to the IDM REST services. | - |
| type | The type of the authentication that should be used. Possible values are: basic, oauth2, oauth2CurrentUser | basic |
Frontend properties
Properties with the prefix flowable.design.frontend
| Property | Description | Default value | Since |
|---|---|---|---|
| form-based-logout | Whether a form based logout should be used in the frontend. | false | 3.12.0 |
| title | The title for the application. | Flowable Design | 3.11.10, 3.12.2 |
| inline-css | Whether to inline the contents of the custom.css in the main index.html | false | 3.11.10, 3.12.2 |
| inline-js | Whether to inline the contents of the custom.js in the main index.html | false | 3.11.10, 3.12.2 |
Frontend Features properties
Properties with the prefix flowable.design.frontend.features
| Property | Description | Default value |
|---|---|---|
| <editorId> | Whether the editor referenced by <editorId> is available in Design. The options for <editorId> are bpmnEditor, cmmnEditor, formEditor, dmnEditor, decisionServiceEditor, dataObjectEditor, channelEditor, eventEditor, pageEditor, serviceEditor, slaEditor, dashboardComponentEditor, documentEditor, securityEditor, actionEditor, userEditor, sequenceEditor, liquibaseEditor, queryEditor, variableExtractorEditor, templateEditor, pluginTaskEditor and dataDictionaryEditor. | true |
| publish | Whether publishing is enabled in Design | true |
Security Access Token properties
Properties with the prefix flowable.design.security.access-token
| Property | Description | Default value |
|---|---|---|
| signing-secret | Your own secret you want to use for the signing. Do note that if the token signing secret is changed, all existing Access Tokens will not be valid anymore. Set a value with at least 32 characters. | - |
Service Registry properties
Properties with the prefix flowable.design.service-registry
| Property | Description | Default value | Since |
|---|---|---|---|
| enable-service-test | Enables the possibility to open a preview in Flowable Design. Please note, that a Flowable Work installation must be connected (with flowable.design.remote.idm-url) and the feature needs to be enabled there as well. | false | 2025.1.01 |
Indexing properties
Properties with the prefix flowable.design.indexing
| Property | Description | Default value | Since |
|---|---|---|---|
| enable-query-test | Enables the possibility to open a preview in Flowable Design for custom queries. Please note, that a Flowable Work installation must be connected (with flowable.design.remote.idm-url) and the feature needs to be enabled there as well. | false | 2025.1.01 |
Agent properties
Properties with the prefix flowable.design.agent
| Property | Description | Default value | Since |
|---|---|---|---|
| enable-agent-test | Enables the possibility to test a utility or external agent in Flowable Design. Please note, that a Flowable Work installation must be connected (with flowable.design.remote.idm-url) and the feature needs to be enabled there as well. | false | 2025.1.01 |