Skip to main content

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.

Properties

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.

Properties with the prefix flowable.design

PropertyDescriptionDefault value
rest-enabledWhether the REST api should be availabletrue
use-basic-user-storeWhether to use a basic user store.true
deployment-api-urlThe root URL to the REST services of the Flowable engine that should be used for deploying applicationshttp://localhost:8080/flowable-work/app-api
undeployment-api-urlThe 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-idOptional tenant id value that should be used when deploying an application
license-locationThe location of the license filefile:${user.home}/.flowable/flowable.license
db-store-enabledWhether the license should be fetched from the databasefalse
multi-tenant-enabledWhether multi tenancy design modelling is enabledfalse
additional-palette-locationsThe additional locations for palette definitions
database-schema-updateThe strategy that should be used for the database update schema (possible values: drop-create, true, false, ignore)true
database-schemaThe database schema to be used for table checks / generation (needed in case the database metadata doesn't return that correctly)
primary-language-codeThe code of the primary language used for modellingen_us
secondary-language-codesThe codes of the additional languages used for modellingde_de,fr_fr,it_it,es_es
deployment-tenant-sourcev3.15.6+ Configure a source for the deployment tenant id.
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 the deployment-api-tenant will not be used. The flowable.design.deployment-tenant-mapping.<source> property can be used to provide a mapping between a Design tenant and a deployment tenant
  • model-workspace-key - Will use the workspace key of the model that is being deployed as deployment source for the configured flowable.design.deployment-tenant-mapping.<source>. Note, that when using this if there is no mapping provided then the configured tenant id in the deployment-api-tenant will be used.

Properties with the prefix flowable.design.deployment.<id> for deploying and undeploying to an additional Flowable runtime system:

PropertyDescription
nameA human readable name for the target environment
deployment-api-urlThe deployment URL of the target environment
undeployment-api-urlThe undeployment URL of the target environment
deployment-api-tenant-idThe tenant to deploy to of the target environment

Properties with the prefix flowable.design.model-locking

PropertyDescriptionDefault value
enabledWhether model locking is enabled.false
auto-lock-on-createWhether models should be auto locked when they are created. Only applicable if model locking is enabled.true

Properties with the prefix flowable.design.security

PropertyDescriptionDefault value
typeThe type of the security that should be used. Possible values: basic, oauth2basic
remember-me-keyThe hash key used by Spring Security for the remember me cookie.false
user-cache-max-sizeHow many users can be cached at any given time in the user security cachetrue
user-cache-validity-periodHow long should a user be cached before invalidating in the user security cache.1m

Properties with the prefix flowable.design.security.oauth2

PropertyDescriptionDefault value
admin-authoritiesA comma separated list of all the authorities which should make the user an admin-
authorities-attributesA comma separated list of the names of the attributes from which authorities should be extracted from without any changes.-
tenant-attributeThe name of the attribute that holds the tenant id for the authentication.-
default-tenantThe default tenant that each user should be assigned to. In case the tenant attribute has no value.default
post-logout-redirect-urlThe post logout redirect URL.-

Properties with the prefix flowable.design.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.design.security.cookie

PropertyDescriptionDefault value
nameThe name of the remember me cookieFLOWABLE_DESIGN_REMEMBER_ME

Properties with the prefix flowable.design.tenant

PropertyDescriptionDefault value
list-providerThe type of the tenant list provider (one of currentTenant, database, fixed)currentTenant
fixed-tenant-idsThe fixed tenant ids. Used only when list-provider is fixed
default-tenant-idThe default tenant id. Models belonging to this tenant will be shown in addition to the user tenant.

Properties with the prefix flowable.design.user-store

PropertyDescriptionDefault value
passwordThe 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

Properties with the prefix flowable.design.frontend

PropertyDescriptionDefault valueSince
form-based-logoutWhether a form based logout should be used in the frontend.false3.12.0
titleThe title for the application.Flowable Design3.11.10, 3.12.2
inline-cssWhether to inline the contents of the custom.css in the main index.htmlfalse3.11.10, 3.12.2
inline-jsWhether to inline the contents of the custom.js in the main index.htmlfalse3.11.10, 3.12.2

Properties with the prefix flowable.design.remote

PropertyDescriptionDefault value
idm-urlThe 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-pathThe context path for the IDM API.idm-api/

Properties with the prefix flowable.design.remote.authentication

PropertyDescriptionDefault value
userThe username used for executing the REST calls (with basic auth) or the client registration id (for oauth2) to the IDM REST services.admin
passwordThe password used for executing the REST calls (with basic auth) to the IDM REST services.-
typeThe type of the authentication that should be used. Possible values are: basic, oauth2, oauth2CurrentUserbasic

Properties with the prefix flowable.design.frontend.features

PropertyDescriptionDefault 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
publishWhether publishing is enabled in Designtrue