Configuration Properties

version

it’s always the release version which is set by the build

String

This parameter tells which version is currently in the system. This information can be found on the login page.

revision

coming from git.properties now, cannot changed

String

This parameter provides the information of the technical and unique identification of the installed version.

versionClaim

empty

String

This parameter is used to highlight different systems so that the users can better distinguish between for example development, staging, UAT, and production systems. It is shown on login page.

timestamp

Coming from git.properties now, cannot be changed

String → Datetime

This parameter shows when the installed version was developed.

adhoc-node-duration

2400

Integer

Process flow does not interrupt when an ad-hoc task created. This property is used for an urgent need and it has 24 hours duration which corresponds to three business days with the default value.

basic-auth-token-name

X-CSRF-Token

String

This property is used to set the default name for the token which used in TSD and REST manager.

blacklist-characters

\x01,\x02,\x03,\x04,\x05,\x0B

String → comma-separated list of character codes

This property is used to list of special chars which are removed and replaced with blank in forms. The list can be expanded with more chars.

blog-article-inheritance optional

null

String → comma-separated list

• read,write

• read

• write

• null or false

This property determines if the notes from the main process should be seen in its subprocesses. If the parameter is set to read the notes are visible. With write, notes from the subprocess are attached to its mainprocess, but not to the subprocess.

Default value is not set here, so any change can be done here for desired result.

default-duration-urgent

100

Integer

This parameter is used to lower every duration in every single node of a process instance to one hour if a process owner opens an urgent process instance.

default-token-valid-duration

1440

Integer

This parameter determines 24 hours time limit for one-time access tokens (link for access has a token) for non-product users.

log-response

false

Boolean

This parameter is used to locking the response from HTTP REST Manager (https://tim-doc.atlassian.net/wiki/spaces/eng/pages/228396040) for debugging issues. The whole response will be received from the rest endpoint when this is set to true.

max-task-link-count-in-mail

50

Integer

When a user is deleted, their tasks will be assigned to their successor or representative. This parameter set the limit for these tasks which can be assigned to 50 at most in the email notification. The other tasks can be seen by the user by checking.

my-instances-mainprocess-only

false

Boolean

This parameter determines which processes will be shown in started instances list.

pick-list-max-users

300

Integer

This parameter determines the maximum number of available users displayed in the group assignment of SIX Administration.

section-lock-timeout

30

Integer

HTML forms have section log information for each section of users when they logged in. This parameter determines the timeout value for section log information.

softlink-nodeinstance-check

true

Boolean

This parameter is used to check for softlinks which are already started so they won't start again in the situation of a process needs to be redone.

userimport-limit

250

Integer

This parameter sets the limitation of how many users can be imported into the product by csv-file. This number can be increased if more users are to be imported.

server-root-url

empty

String

This property determines the URL for server redirect behind load balancer.

cloud-environment

false

Boolean /
String → aws

This parameter is used to set licensed cloud service if company uses cloud. Possible values are aws or false. azure is not supported yet.

no-cache

false

Boolean

This parameter determines if the browser cache information will automatically deleted for every login.

enable-login-cache-flushing

true

Boolean

This parameter is used to delete the login cache every time the user logs in. It is created to prevent troubles during big migrations.

login-provider

This property is commented out. Can be set to:

com.dooris.security.providers.HttpBasicLoginProvider

Namespace

Any server can be pointed if it is asking for a HTTP basic login. This parameter determines the server which will be taken as a reference to decide if the user can login or not.

http-basic-login-provider-host

• http-basic-login-provider-host-<tenantname>

This property is commented out. Can be set to:

https://postman-echo.com/basic-auth

URL

This parameter determines the login provider's host name.

http-basic-login-provider-skip-tenant

• http-basic-login-provider-skip-tenant-<tenantname>

true

Boolean

tenantName/ is not sent when entering the login information by default true value of this property, if the tenant information wanted to be skipped.

Open

ldap-single-transaction-size

250

Integer

This parameter determines the number of users taken per transaction for https://tim-doc.atlassian.net/wiki/spaces/eng/pages/227871731 timers to calculate the necessary number of users wanted to perform in one single transaction. If there are more than 250 users, the transaction chunks will be divided into blocks of up to 250 users.

saml-old-tim-client

true

it will be false someday but now its true

Boolean

This property determines which front end client will be used for SAML users, when they log in. The value true means that the legacy front end (“roots“) will be used. If it is set to false the current front end client implementation (“SIX“) will be used.

stringvalue-max-mysql

4000

Integer

These properties determine the limit for process variable´s key values in the stringvalue column in the database.

stringvalue-max-mssql

50000

Integer

stringvalue-max-oracle

4000

Integer

stringvalue-max-default

4000

Integer

fail-on-database-check

false

Boolean

This parameter determines to check if there is a database connection fail for AliveCheckServlet. If the database wanted to be checked, this parameter can be set to true and AliveCheckServlet will be failed, too.

mysql-collation

empty

String → MySQL :: Supported Character Sets and Collations
Example: utf8_bin

This property is used to set a custom mySQL collation if the customer is using one.

resource-size-treshold

20480

Integer

This parameter determines the threshold for resource files when uploading them to resource folder. This threshold defines which files are kept in memory only or which are kept in the local temporary folder.

resource-size-max

10

Integer

This parameter determines the maximum size of resource documents when uploading. If the file is bigger than the defined value the user is not allowed to upload the resource file and a warning will be shown.

zip-max-files

250

Integer

This parameter determines the maximum amount of ZIP entries that are contained within the package to upload to the resource folder. If more files are contained in the package than the defined value the user is not allowed to upload the resource file and a warning will be shown.

csv-encodings

UTF-8;ISO-8859-1;Windows-1251

String

This parameter determines the content encoding for uploaded CSV files for use.
The defined encoding formats will be shown in the dropdown list for CSV imports, e.g. for the bulk https://tim-doc.atlassian.net/wiki/spaces/eng/pages/228493440:

Open

zip-encodings

Cp437;UTF-8;ISO-8859-1

String

This parameter determines the ZIP encoding for upload to resource folder.

document-size-treshold

20480

Integer

This parameter determines the threshold that defines which files are kept in memory only or which are kept in a local temporary folder when uploading product document files.

document-size-max

10

Integer

This parameter determines the maximum size per file when uploading it in the Documents tab of the product. Each file you want to upload must be lower than 10 MB or there will be an error pop up notification.

upload-size-max

50

Integer

This parameter determines the maximum upload size when more than one file is uploaded at once. For example, with the default value of 50 MB, six documents with the size of 10 MB each cannot be uploaded at once.

tenant-max-storage-size

-1

Integer

This parameter determines the maximum storage size per tenant.

timPdfConverter

aspose

aspose

This parameter determines the default vendor for PDF conversion with the default value aspose.

docconverter-rollback

true

Boolean

This parameter determines whether the conversion process should be rolled back when it runs into a timeout.

convert-on-upload

• convert-on-upload-<tenantname>

false

Boolean

This parameter determines whether the office documents (doc, docx, xls, xlsx, ppt, pptx, txt, csv) should be converted to .pdf directly when they are uploaded. If it is set to true, PDF documents will be generated out of the office documents when they are uploaded.

convert-on-upload-keep-original

• convert-on-upload-keep-original-<tenantname>

false

Boolean

This parameter determines whether the original office document (doc, docx, xls, xlsx, ppt, pptx, txt, csv) will be kept in addition to the generated .pdf document. If it is set to true, the original documents will be kept after PDF conversion.

enable-html-escaping

false

• true

• false

This property can be used to enable rich text escaping of HTML tags. If this is true, all html text will be written as a plain text.

ocr-documents-whitelist

• ocr-documents-whitelist-<tenantname>

pdf

File extension types separated by ';'

This property contains all whitelisted file types which can be used by the OCR Timer.

aspose-xls-permit-pivot

true

Boolean

This parameter determines if pivot tables are allowed to upload to database.

aspose-xls-rows-limit

2147483647

Integer

This parameter is used to determine the maximum number of rows that are allowed to upload xls or xlsx file.

aspose-pdf-conversion-timeout-ms

10000

Integer

This parameter is used to set the timeout limit for PDF conversion. There will be an error message if this limit is exceeded during the conversion.

aspose-pdf-merge-timeout-ms

10000

Integer

This parameter is used to set the timeout limit for PDF merge. There will be an error message if this limit is exceeded during the merging.

aspose-txt-rows-limit

10000

Integer

This parameter is used to determine the maximum number of rows that are allowed to upload txt file.

document-upload-content-whitelist

• document-upload-content-whitelist-<tenantname>

see below

String
→ comma-separated MIME types

This parameter determines supported file types for the DMS part of the product which will be validated when uploading files on the Documents tab. It won’t be checked when uploading files in the Resources section.

dms-user-has-tasks

• dms-user-has-tasks-<tenantname>

true

• true

• false

This parameter checks for the user who wants to upload, delete or rename the documents and has a task for it. If not it is a read-only.

dms-user-has-tasks-prevent-upload

• dms-user-has-tasks-prevent-upload-<pdname>

false

• true

• false

If this parameter is false, upload of documents is allowed. <pdname> stands for the process definition name which can be inserted here if upload of documents should be prevented with the value true.

dms-user-has-tasks-prevent-delete

• dms-user-has-tasks-prevent-delete-<pdname>

false

• true

• false

This parameter determines if the deletion of documents is allowed or not. If this parameter is set to true, deleting of documents is not allowed. <pdname> stands for the process definition name which can be inserted here if deleting documents should be prevented with the value true.

dms-user-check-processowner

• dms-user-check-processowner-<tenantname>

false

• true

• false

If this parameter is true, users with role process owner are exempt of the open task instance check.

dms-prevent-docmod

• dms-prevent-docmod-<pdname>

• dms-prevent-docmod-<pdname>-<activityname>

true

• true

• false

This parameter prevents document modification for a process definition or/end activity name with the default true value.

dms-provider

• dms-provider-<tenantname>

Property with no default. Must be set explicitly!

sharepoint

• sharepoint-online → SharePoint Online (Office365)

• sharepoint → SharePoint (on-premise)

• empty → native TIM DMS

This parameter determines the Sharepoint provider to handle all the document management.

dms-provider-username

• dms-provider-username-<tenantname>

Property with no default. Must be set explicitly!

tim\tim_service

String

This parameter is used to determine the user name which is required to authenticate with the DMS provider.

dms-mainprocess-storage

false

• read

• write

• read,write

• false

This parameter is used to read the documents from the main process and write new documents to the main process.
read means reading the documents from the main process.
write means writing the documents from the main process.
read,write means reading the documents from the main process and write new ones.
false means no reading or writing will be done.

dms-mainprocess-storage-filter

Property with no default. Must be set explicitly!

String

AnyPrefix%

This parameter is used to filter documents which should be not shown to the subprocess. Prefix can be beginning, ending of in the middle of a word and can be set up for the needed result.

% means anything.

dms-virus-scan-provider

This property is commented out. Can be set to:

• com.timbpm.dms.security.IcapScanProvider

• com.timbpm.dms.security.SymantecScanProvider

String

This property is used to define which virus scan provider should be used if any.

dms-icap-hostname

This property is commented out. Can be set to:

127.0.0.1

String

These properties are used by the ICAP virus scan provider.

dms-icap-port

This property is commented out. Can be set to:

1344

Integer

dms-icap-servicename

This property is commented out. Can be set to:

srv_clamav?allow204=on&force=on&sizelimit=off&mode=simple

String

dms-icap-mode

This property is commented out. Can be set to:

RESPMOD or REQMOD

String

dms-icap-username

This property is commented out. Can be set to:

timServer

String

dms-icap-request-source

This property is commented out. Can be set to:

file

String

dms-symantec-server

127.0.0.1:1344

• <IP>:<PORT>[:<PERSISTENT CONNECTION COUNT>];<IP>:<PORT>;...

Multiple servers can be specified for load balancing. Persistent connection count is optional field, will be considered disabled if absent or if value <= 0.

dms-symantec-policy

scan

• scan

• scanrepair

• scanrepairdelete

• scandelete

Defaults to Symantec Protection Engine Scan Policy - in TIM context scanrepair* does not make sense as we do not take back the file from scanner.

dms-symantec-api

0

• 0

• 1

• 2

Use value 0 to scan file with legacy API's.

Use value 1 to scan file with new API's, provides more information about threat detected.

Do not use value 2. It's unsupported - normally use 2 to scan file with new Insight API's, facilitates to provide file context (SHA256, MD5, digital signing status, source URL, source IP, etc) along with file scan request. Scan result provides more information about threat detected and file details.

dms-symantec-cache-setup

true

• true

• false

cache setup after initialization - this value must be set to false if you want to reload the other symantec properties by AliveCheckServlet.do?reload=true

dashboard-currentclient-query-mysql

select @currentClient:=TIMCURRENTCLIENTID

String

This parameter allows to define an SQL query for the current client to make sure that the views are accessible only in the context of the current client in MySQL.

dashboard-currentclient-query-oracle

select setCurrentClient(TIMCURRENTCLIENTID) from dual

String

This parameter allows to define an SQL query for the current client to make sure that the views are accessible only in the context of the current client in Oracle.

dashboard-currentclient-query-mssql

select dbo.setCurrentClient(TIMCURRENTCLIENTID)

String

This parameter allows to define an SQL query for the current client to make sure that the views are accessible only in the context of the current client in SSMS (SQL Server Management Studio).

default-client

super

String

This parameter defines the default tenant name to search when there is no tenant information added to the user information during the login. Any tenant name can be added here as a default to search the user when the user does not enter the tenant information.

registrationForm

/loom-portal/

String

The user will be forwarded to this registration form if the user could not be found via SAML: saml means single sign on. you can specify a link to sent a user if a user cant be found with saml.

registrationForm=/loom-portal/super-resource/unauthorized.htm?disposition=inline

application-type

loom-portal

String → tim/client

Defining the client name between the old client (loom-portal) or the new client (tim/client) while sending out emails with deeplinks.

application

loom-portal

String

This property is used to generate link for the directory part with roots front-end loom-portal.

six-application

tim/client

String

This property is used to generate link for the directory part with the new front end which is SIX front-end.

show-completed-tasks-in-saved-filters

true

Boolean

This parameter determines how the system should behave for completed tasks if a filter is created in SIX to show the tasks.

user-profile-fields

phoneNumber,country,companyName,companyId,personnelNumber,supervisor,costCenter,department,departmentChief,taskMailLinkTarget,notifyAsignee,notifyByMail,notifyByMailIfNotPreviousActor,tableRowCount,responsiveMode

Comma separated list of all possible user-profile fields.

This property is used to define which user-profile fields can be set by every user.

user-profile-fields-editable-only-by-admin

empty

Comma separated list of all possible user-profile fields.

This property is used to define which user-profile fields can only be set by an administration user.

slot-search-manager-group

empty

String → group must be available

SUPER_USER_GROUP_NAME

Group name can be used to find all instances of all process definitions in the current tenant for that specified group and gives full access to that group in that specific tenant.

search-for-processvariables

true

Boolean

This parameter determines to do the search also in process variables or only in the process name. Default true value adds the process variables in the search alongside with process names.

search-min-length

3

Integer

This parameter determines the character number which is needed to do the slot search.

search-wildcard

*

Character

This parameter determines which character is allowed to add a wildcard to the search.

search-fulltextindex

false

Boolean

It's a premium feature for SQL Server. If this is set to true, it should be enabled also in the SQL server environment. Can search for wildcards for “ends with”. For example, it can be searched for three separate words which are in different places in a big text. With this parameter results can be found for all kind of search easily and in a fast way.

search-resultset-limit

1000

Integer

form-bootstrap

false

Boolean

This parameter prevents adding bootstrap JavaScript libraries to the form area automatically by default value false.

form-access-mode

multi

• multi

• single you open the form and you need to lock it so noone can change it until you left the page

• single-auto

This parameter defines the access to the form such as multi, single or single-auto (first come first serve option).
Default value multi allows two or more people to open a form and work on it.
single means when the user opens the form, it should be locked by that user manually so noone can change it until that specific user leaves the page.
single-auto means when a user opens a form, it will be automatically locked for that user so noone can change it until that specific user leaves the page.

times-refresh-needed-minutes

2

Integer

This parameter determines the interval which is used to calculate the times. Times are calculated in a bigger interval if this is increased.

times-refresh-max-threshhold-minutes

120

Integer

This parameter determines the treshhold for calculating every nodes time. .

loop-detect-limit

10000

Integer

This parameter determines the limit for checking if a process leads to a loop. If it exceeds the limit, it will be marked as a loop.

ignore-old-timerlock-minutes

30

Integer

When a timer runs, it creates a lock in the database. This parameter is used to set the time limit for these locks which will be removed after 30 minutes in all cases by the default value.

archive-timer-keep-instances-min

2y

String

This parameter is used to set a minimum time span where instances are not archived if the timer ProcessInstanceManager.archiveExpiredProcessInstances is running. If it is set to 2y instances are kept for at least 2 years. Setting this value to a small number would cause data loss.

delete-timer-keep-instances-min

2y

String

If the timer ProcessInstanceManager.deleteExpiredProcessInstances is running, this property, will delete all instances after two years.

delete-timer-archive-state-check

true

Boolean

This property is used to determine whether to only delete the process instances which has been archived before with the default value true.

server-timestamp-auto-conversion

true

This parameter determines if server-timestamp-output-timezone will be taken into consideration. If this is set to false then date will not be converted.

server-timestamp-output-timezone

Europe/Berlin

String → List of Time Zones of the World - TimeZoneDB

This parameter defines the timezone which will be used to convert the date.

server-timestamp-auto-formatting

true

This parameter determines if server-timestamp-output-format will be taken into consideration. If this is set to false, the date will not be formatted.

server-timestamp-output-format

dd.MM.yyyy HH:mm:ss

This parameter defines the format which will be used to format the date.

server-timestamp-output-convert-to-date-if-midnight

true

This property determines if server-timestamp-date-output-format will be taken into consideration. If this is set to false, the date will not be formatted.

server-timestamp-date-output-format

dd.MM.yyyy

This parameter determines the format which will be used to format the date if it is midnight.

enable-cpm

true

Boolean

This parameter determines whether the will be used.

enable-time-interceptor

• enable-time-interceptor-<tenantname>

true

Boolean

This parameter determines whether the time should be calculated or not, and can be set for a specific tenant. Tenant name can be inserted to <tenantname>.

ext.rest1user

Property with no default. Must be set explicitly!

example: testuser

String

Custom properties can be set in this external property lookup section when a third party endpoint is connected in the process and the customer does not want to have this information inside of the process and want to keep it in the properties to not to make it available to everybody.

examples for property lookup via ${ext.xxxxx}
→ ${ext.rest1user} will look this up

ext.rest1pass

Property with no default. Must be set explicitly!
Example: $enc$-328c00018ea77fa182d0c467a54b129

String → encrypted

It can be encrypted with this property and can be decrypted in real time. Information can be put in properties which is confidential and should not be read by any other people without decryption.

examples for property lookup via ${ext.xxxxx}
→ ${ext.rest1pass} will look this up

ext.rest1host

Property with no default. Must be set explicitly!
Example: http://localhost:9999/rest1

URL

Examples for property lookup via ${ext.xxxxx}
→ ${ext.rest1host} will look this up