Configuration Properties / tim.properties


This page explains the properties that can be applied to all or a specific tenant.

All the configuration properties are defined in a file that is called tim.properties and can be uploaded to the resources folder.

Only administration users are allowed to change this file.


Header about Product Version Information

version=vDevTrunk revision=rXXX.cYYY timestamp=17.03.2016 8:00

Property Key

Default Value

Allowed Values

Description

Property Key

Default Value

Allowed Values

Description

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.

This property should not be changed and is defined by TIM Solutions for each release TIM BPM.

revision

coming from git.properties now, cannot changed

String

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

This property should not be changed and is defined by TIM Solutions for each release TIM BPM.
Revision information is shown on the login page at the tooltip.

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.


General Settings

Property Key

Default Value

Allowed Values

Description

Property Key

Default Value

Allowed Values

Description

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 (HTTPRestManager) 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.


Environment Settings

Server Configuration (Root URL)

Property Key

Default Value

Allowed Values

Description

Property Key

Default Value

Allowed Values

Description

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.

 

Cache Handling Settings

Property Key

Default Value

Allowed Values

Description

Property Key

Default Value

Allowed Values

Description

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

Property Key

Specificity

Default Value

Allowed Values

Description

Property Key

Specificity

Default Value

Allowed Values

Description

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.

ldap-single-transaction-size

 

250

Integer

This parameter determines the number of users taken per transaction for LDAP 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.


Database Settings

Property Key

Default Value

Allowed Values

Description

Property Key

Default Value

Allowed Values

Description

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.


File Handling

Resource Files

Property Key

Default Value

Allowed Values

Description

Property Key

Default Value

Allowed Values

Description

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 User Import/Export:

zip-encodings

Cp437;UTF-8;ISO-8859-1

String

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

 

Documents

Property Key

Specificity

Default Value

Allowed Values

Description

Property Key

Specificity

Default Value

Allowed Values

Description

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

Property Key

Specificity

Default Value

Allowed Values

Description

Property Key

Specificity

Default Value

Allowed Values

Description

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 Specific Settings for XLS, PDF, and TXT

Property Key

Default Value

Allowed Values

Description

Property Key

Default Value

Allowed Values

Description

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 Uploads: Supported File Types

Property Key

Specificity

Default Value

Allowed Values

Description

Property Key

Specificity

Default Value

Allowed Values

Description

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.

 

image/gif, image/jpeg, image/png, image/svg+xml, text/csv, text/plain, text/xml, application/json, application/pdf, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/msword, application/msexcel, application/mspowerpoint, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.wordprocessingml.template, application/vnd.openxmlformats-officedocument.spreadsheetml.template, application/vnd.openxmlformats-officedocument.presentationml.template, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/vnd.ms-word.document.macroEnabled.12, application/vnd.ms-word.template.macroEnabled.12, application/vnd.ms-excel.sheet.macroEnabled.12, application/vnd.ms-excel.template.macroEnabled.12, application/vnd.ms-excel.addin.macroEnabled.12, application/vnd.ms-excel.sheet.binary.macroEnabled.12, application/vnd.ms-powerpoint.addin.macroEnabled.12, application/vnd.ms-powerpoint.presentation.macroEnabled.12, application/vnd.ms-powerpoint.template.macroEnabled.12, application/vnd.ms-powerpoint.slideshow.macroEnabled.12, application/vnd.ms-access, application/vnd.rar, application/x-rar-compressed, application/x-7z-compressed, application/x-tar, application/tar, application/tar+gzip, application/zip, application/octet-stream, application/x-zip-compressed, multipart/x-zipcontent-disposition-inline-whitelist=application/pdf, image/gif, image/jpeg, image/png, image/heic

 

  • images

    • .gif .jpg .jpeg .png .svg .heic .heif

  • text files

    • .txt .xlm

  • data

    • .json .mdb

  • spreadseet

    • .csv .xlsx .xltx .xls .xlt .xla .xlsm .xltm .xlam .xlsb

  • documents

    • .pdf .doc .docx .docm .dot .dotx .dotm .odt

  • presentations

    • .pptx .potx .ppsx .ppt .pot .pps .ppa .ppam .pptm .potm .ppsm

  • packages

    • .rar .7z .tar .tar.gz .tgz .zip

 

DMS Settings

Managing the Document Management System (DMS)
The TIM intern Document Management System manages the documents, which are attached to processes, activities, and tasks. The DMS's functionality can be effected using the following parameters in the tim.properties.

Property Key

Specificity

Default Value

Allowed Values

Description

Property Key