List of System Properties by Area

This chapter lists the system properties which are relevant for the following areas.

CMRF & DWH Configuration

autocommit.cf.changes

Module: cmas-dwh-server
Description: Defines whether DWH tasks which result from configurational changes on ticket fields are executed automatically without manual interaction in the Admin Tool. Can be also set in the Admin Tool in the navigation item DWH. The default and recommended value is false.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false (default value)
Since: 6.7.0

batch-commit-interval

Module: cmas-dwh-server
Description: Number of objects sent in one DWH message. Larger values mean better transfer performance at the cost of higher memory usage.
Starting with ConSol CM version 6.11, this property is only used if the package size of a DWH operation is not set. This can only happen when the command is directly addressed to the Java MBean consol.cmas.global.dwh.synchronizationService, e.g. using the update() method. When a DWH operation is started using the Admin Tool, there is always a value for the package size. If not explicitly set, the default value of 1000 is used as value for batch.commit.interval.
Default value: 1000
Type: integer
Restart required: no
System: yes
Optional: yes
Example value: 100
Since: 6.0.0

communication.channel

Module: cmas-dwh-server
Description: Communication channel. Only possible value since CM version 6.11.0.0: DIRECT
Type: string
Restart required: no
System: yes
Optional: no
Example value: DIRECT
Since: 6.8.5.0
Removed in: 6.11.0.0 (DIRECT mode is the only available mode and is set automatically)

dwh.mode

Module: cmas-dwh-server
Description: Currently active mode for the DWH data transfer. Possible values are OFF, ADMIN, LIVE.
Type: string
Restart required: no
System: yes
Optional: no
Example value: OFF
Since: 6.0.1

ignore-queues

Module: cmas-dwh-server
Description: A comma-separated list of queue names which are not not transferred to the DWH.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: QueueName1,QueueName2,QueueName3
Since: 6.6.19
Removed in: 6.8.1

java.naming.factory.initial

Module: cmas-dwh-server
Description: Factory class for the DWH context factory.
Type: string
Restart required: no
System: yes
Optional: no
Example value: org.jnp.interfaces.NamingContextFactory
Since: 6.0.1
Removed in: 6.11.0.0

java.naming.factory.url.pkgs

Module: cmas-dwh-server
Description:
Type: string
Restart required: no
System: yes
Optional: no
Example value: org.jboss.naming:org.jnp.interfaces
Since: 6.0.1
Removed in: 6.11.0.0

java.naming.provider.url

Module: cmas-dwh-server
Description: URL of naming provider.
Type: string
Restart required: no
System: yes
Optional: no
Example value: localhost
Since: 6.0.1
Removed in: 6.11.0.0

notification.error.description

Module: cmas-dwh-server
Description: Defines the text for error emails from the DWH.
Type: string
Restart required: no
System: yes
Optional: no
Example value: Error occurred
Since: 6.0.1

notification.error.from

Module: cmas-dwh-server
Description: Defines the From address for error emails from the DWH.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: myuser@consol.de
Since: 6.0.1

notification.error.subject

Module: cmas-dwh-server
Description: Defines the email subject for error emails from the DWH.
Type: string
Restart required: no
System: yes
Optional: no
Example value: Error occurred
Since: 6.0.1

notification.error.to

Module: cmas-dwh-server
Description: Defines the To address for error emails from the DWH.
Type: string
Restart required: no
System: yes
Optional: no
Example value: myuser@consol.de
Since: 6.0.1

notification.finished_successfully.description

Module: cmas-dwh-server
Description: Defines the text for emails from the DWH when a transfer finishes successfully.
Type: string
Restart required: no
System: yes
Optional: no
Example value: Transfer finished successfully
Since: 6.0.1

notification.finished_successfully.from

Module: cmas-dwh-server
Description: Defines the From address for emails from the DWH when a transfer finishes successfully.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: myuser@consol.de
Since: 6.0.1

notification.finished_successfully.subject

Module: cmas-dwh-server
Description: Defines the subject for emails from the DWH when a transfer finishes successfully.
Type: string
Restart required: no
System: yes
Optional: no
Example value: Transfer finished successfully
Since: 6.0.1

notification.finished_successfully.to

Module: cmas-dwh-server
Description: Defines the To address for emails from the DWH when a transfer finishes successfully.
Type: string
Restart required: yes
System: yes
Optional: no
Example value: myuser@consol.de
Since: 6.0.1

notification.finished_unsuccessfully.description

Module: cmas-dwh-server
Description: Defines the text for emails from the DWH when a transfer finishes unsuccessfully.
Type: string
Restart required: no
System: yes
Optional: no
Example value: Transfer finished unsuccessfully
Since: 6.0.1

notification.finished_unsuccessfully.from

Module: cmas-dwh-server
Description: Defines the From address for emails from the DWH when a transfer finishes unsuccessfully.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: myuser@consol.de
Since: 6.0.1

notification.finished_unsuccessfully.subject

Module: cmas-dwh-server
Description: Defines the subject for emails from the DWH when a transfer finishes unsuccessfully.
Type: string
Restart required: no
System: yes
Optional: no
Example value: Transfer finished unsuccessfully
Since: 6.0.1

notification.finished_unsuccessfully.to

Module: cmas-dwh-server
Description: Defines the To address for emails from the DWH when a transfer finishes unsuccessfully.
Type: string
Restart required: no
System: yes
Optional: no
Example value: myuser@consol.de
Since: 6.0.1

notification.host

Module: cmas-dwh-server
Description: Email (SMTP) server hostname for sending DWH emails.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: myserver.consol.de
Since: 6.0.1

notification.password

Module: cmas-dwh-server
Description: SMTP password for sending DWH emails (optional).
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.0.1

notification.port

Module: cmas-dwh-server
Description: SMTP port for sending DWH emails.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: 25
Since: 6.0.1

notification.protocol

Module: cmas-dwh-server
Description: The protocol used for sending emails from the DWH. Possible values are smtp or pop3.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: pop3

notification.tls.enabled

Module: cmas-dwh-server
Description: Enables SMTP via SSL/TLS (SMTPS) for sending notification emails from the DWH. The default value is false. If it is set to true, SMTPS is enabled for sending notifications from the DWH.
Type: string
Restart required: yes
System: no
Optional: yes
Example value: false (default value)
Since: 6.11.1.6

notification.username

Module: cmas-dwh-server
Description: (SMTP) user name for sending DWH emails.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: myuser
Since: 6.0.1

recoverable.exceptions

Module: cmas-dwh-server
Description: Comma-separated list of exception definitions: CLASS[+][:REGEX]. The exceptions included in the list do not stop CM from sending to the CMRF process, but force it to try again. If optional '+' after CLASS is present, classes which extend CLASS are matched.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: java.sql.SQLRecoverableException,java.lang.RuntimeException+:.*T.1\,2T.*
Since: 6.8.4.6

skip-ticket

Module: cmas-dwh-server
Description: Tickets are not transferred during transfer/update.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.6.19
Removed in: 6.8.1

skip-ticket-history

Module: cmas-dwh-server
Description: History of ticket is not transferred during transfer/update.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.6.19
Removed in: 6.8.1

skip-unit

Module: cmas-dwh-server
Description: Units are not transferred during transfer/update.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.6.19
Removed in: 6.8.1

skip-unit-history

Module: cmas-dwh-server
Description: History of unit is not transferred during transfer/update.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.6.19
Removed in: 6.8.1

split.history

Module: cmas-dwh-server
Description: Changes the SQL that fetches the history for the tickets during DWH transfer so that the history is not fetched for all tickets at once but only for one ticket per SQL.
Type: boolean
Restart required: no
System: yes
Optional: yes
Example value: false
Since: 6.8.0
Removed in: 6.8.4.0

unit.transfer.order

Module: cmas-dwh-server
Description: Defines in which order customer field groups should be transferred to the DWH.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: company;customer
Since: 6.6.19
Removed in: 6.8.1

Indexer and Search Configuration

Indexer

big.task.minimum.size

Module: cmas-core-index-common
Description: Indicates the minimum size of index task (in parts, each part has 100 entities) to qualify this task as a big one. Big tasks have a lower priority than runtime tasks.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 15 (default value)
Since: 6.8.3

database.notification.redelivery.delay.seconds

Module: cmas-core-index-common
Description: If the database is used as a notification channel for index updates, this property indicates the delay for notification redelivery when an exception occurs.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 60
Since: 6.8.4.7

database.notification.redelivery.max.attempts

Module: cmas-core-index-common
Description: If the database is used as a notification channel for index updates, this property indicates maximum redelivery attempts when an exception occurs.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 60
Since: 6.8.4.7

disable.admin.task.auto.commit

Module: cmas-core-index-common
Description: Toggle for the automatic execution of administrative index update tasks. If set to false, possibly expensive index tasks created as a result of configuration changes will be automatically executed right after creation. It is recommended to set this value to true, so that the execution of administrative index tasks needs to be manually triggered in the Admin Tool or Web Admin Suite.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.6.1

index.attachment

Module: cmas-core-index-common
Description: Determines whether the content of attachments is indexed.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: true
Since: 6.4.3

index.history

Module: cmas-core-index-common
Description: Determines whether ticket and customer history is indexed.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.1.0
Removed in: 6.11.0

index.status

Module: cmas-core-index-common
Description: Index synchronization status, possible values are GREEN, YELLOW or RED. This value is set internally by the index system, please do not change it manually unless advised by ConSol.
Type: string
Restart required: no
System: yes
Optional: no
Example value: GREEN
Since: 6.6.1

index.task.worker.threads

Module: cmas-core-index-common
Description: Sets the number of threads that will be used to execute index tasks. The default value is 1, we recommend to increase it slightly on systems with large indexer load up to a value of 4.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1 (default value)
Since: 6.6.14, 6.7.3. Since 6.8.0 and exclusively in 6.6.21 also normal (live) index updates are affected by this property.

index.version.current

Module: cmas-core-index-common
Description: Holds information about the current index version. This value is maintained internally, please do not change it unless advised by ConSol.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1 (default value)
Since: 6.7.0

index.version.newest

Module: cmas-core-index-common
Description: Holds information about which index version is considered newest. This value is maintained internally, please do not change it unless advised by ConSol.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1 (default value)
Since: 6.7.0

indexed.assets.per.thread.in.memory

Module: cmas-core-index-common
Description: Determines how many assets should be loaded into memory at once, per thread, during indexing.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 200 (default value)
Since: 6.8.0

indexed.engineers.per.thread.in.memory

Module: cmas-core-index-common
Description: Determines how many engineers should be loaded into memory at once, per thread, during indexing. Increasing it slightly will lead to better indexer performance at the price of higher memory consumption.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 300 (default value)
Since: 6.6.14, 6.7.3

indexed.resources.per.thread.in.memory

Module: cmas-core-index-common
Description: Determines how many resources should be loaded into memory at once, per thread, during indexing. Increasing it slightly will lead to better indexer performance at the price of higher memory consumption.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 200 (default value)
Since: 6.10.0.0

indexed.tickets.per.thread.in.memory

Module: cmas-core-index-common
Description: Determines how many tickets should be loaded into memory at once, per thread, during indexing. Increasing it slightly will lead to better indexer performance at the price of higher memory consumption.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 100 (default value)
Since: 6.6.14, 6.7.3

indexed.units.per.thread.in.memory

Module: cmas-core-index-common
Description: Determines how many customers should be loaded into memory at once, per thread, during indexing. Increasing it slightly will lead to better indexer performance at the price of higher memory consumption.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 200 (default value)
Since: 6.6.14, 6.7.3

synchronize.master.address

Module: cmas-core-index-common
Description: Value of -Dcmas.http.host.port specifying how to connect to the indexing master server. Since 6.12.0.0 it is possible to switch the node acting as master node by entering the address of the new master node. The index updates are archived for the time configured in the property cmas-core-index-common, synchronize.archive.timeout.minutes, so the new master can recover missing data in case it had not been fully synchronized with the previous master indexing server at the moment of switch.
Type: integer
Restart required: no
System: yes
Optional: yes
Example value: 127.0.0.1:80
Since: 6.6.0

synchronize.master.security.token

Module: cmas-core-index-common
Description: The password for accessing the index snapshot via URL, e.g., for index synchronization or for backups. This value is negotiated between nodes internally, please do not change it manually unless advised by ConSol.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: token
Since: 6.6.0

synchronize.master.security.user

Module: cmas-core-index-common
Description: The user name for accessing the index snapshot via URL, e.g., for index synchronization or for backups. This value is negotiated between nodes internally, please do not change it manually unless advised by ConSol.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: user
Since: 6.6.0

synchronize.master.timeout.minutes

Module: cmas-core-index-common
Description: Determines how much time (in minutes) the master server may continually fail until a new master gets elected. 0 means that master server will never change (failover mechanism is disabled).
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 5 (default value)
Since: 6.6.0

synchronize.megabits.per.second

Module: cmas-core-index-common
Description: Determines how much bandwidth (in megabits) the master server may consume when transferring index changes to all slave servers. Do not use all available bandwidth to transfer index changes between hosts, as doing so will most probably partition the cluster due to some subsystems being unable to communicate.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 85 (default value)
Since: 6.6.0

synchronize.sleep.millis

Module: cmas-core-index-common
Description: Determines how often each slave server polls the master server for index changes.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1000 (default value)
Since: 6.6.0

Search Results

globalSearchResultSizeLimit

Module: cmweb-server-adapter
Description: Determines the maximum number of results in the quick search.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 10
Since: 6.0

searchPageSize

Module: cmweb-server-adapter
Description: The global default page size for search results in the Web Client. Only used for new users who have not yet set preferences.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 20
Since: 6.0

searchPageSizeOptions

Module: cmweb-server-adapter
Description: Paging options for the page size of search results in the Web Client.
Type: string
Restart required: no
System: yes
Optional: no
Example value: 10|20|30|40|50|75|100
Since: 6.0

unitIndexSearchResultSizeLimit

Module: cmweb-server-adapter
Description: Defines the maximum number of hints for all customer autocomplete or suggestion components (e.g. when adding customer to a ticket). Components customizations (maxHints, maxSuggestions) may change that value.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 5
Since: 6.0

LDAP Configuration

LDAP Configuration (if LDAP is Used as Authentication Mode in the CM Web Client)

LDAP parameters apply only if the authentication mode for the CM Web Client has been set to LDAP:

engineer.authentication.method

Module: cmas-core-security
Description: Sets the authentication method for users. Possible values are: DATABASE, LDAP, LDAP,DATABASE, DATABASE,LDAP
Type: string
Restart required: no
System: yes
Optional: no
Example value: DATABASE
Since: 6.14.0.0

ldap.engineer.NAME.basedn

Module: cmas-core-security
Description: Base DN used for looking up LDAP user accounts when using LDAP authentication.
Type: string
Restart required: no
System: yes
Optional: no
Example value: ou=accounts,dc=consol,dc=de
Since: 6.14.0.0

ldap.engineer.NAME.password

Module: cmas-core-security
Description: Password for connecting to LDAP to look up users when using LDAP authentication. Only needed if lookup cannot be performed anonymously.
Type: password
Restart required: no
System: yes
Optional: yes
Since: 6.14.0.0

ldap.engineer.NAME.providerurl

Module: cmas-core-security
Description: URL to LDAP provider, when using LDAP authentication.
Type: string
Restart required: no
System: yes
Optional: no
Example value: ldap://myserver.consol.de:389
Since: 6.14.0.0

ldap.engineer.NAME.searchattr

Module: cmas-core-security
Description: Search attribute for looking up the LDAP entries associated with a CM login.
Type: string
Restart required: no
System: yes
Optional: no
Example value: uid
Since: 6.14.0.0

ldap.engineer.NAME.userdn

Module: cmas-core-security
Description: LDAP user for connecting to LDAP to look up users when using LDAP authentication. Only needed if the lookup cannot be performed anonymously.
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.14.0.0

ldap.initialcontextfactory

Module: cmas-core-security
Description: Class name for the initial context factory of the LDAP implementation when using LDAP authentication. Usually this is com.sun.jndi.ldap.LdapCtxFactory.
Type: string
Restart required: yes
System: yes
Optional: no
Example value: com.sun.jndi.ldap.LdapCtxFactory
Since: 6.0

LDAP Configuration (if LDAP is Used as Authentication Mode in CM/Track)

LDAP parameters apply only if the authentication mode for CM/Track has been set to LDAP:

contact.authentication.method

Module: cmas-core-security
Description: Sets the authentication method for contacts accessing REST services, possible values are DATABASE or LDAP or LDAP,DATABASE or DATABASE,LDAP.
Type: string
Restart required: no
System: yes
Optional: no
Example value: LDAP
Since: 6.9.3.0

ldap.contact.Name.basedn

Module: cmas-core-security
Description: Base path to search for the contact DN by LDAP ID.
Type: string
Restart required: no
System: no
Optional: yes
Example value: ou=accounts,dc=consol,dc=de
Since: 6.9.3.0

ldap.contact.Name.password

Module: cmas-core-security
Description: Password to look up the contact DN by LDAP ID. If not set, the anonymous account is used.
Type: string
Restart required: no
System: no
Optional: yes
Since: 6.9.3.0

ldap.contact.Name.providerurl

Module: cmas-core-security
Description: Address of the LDAP server (ldap[s]://host:port) used for contact authentication.
Type: string
Restart required: no
System: no
Optional: yes
Example value: ldap://ldap.consol.de:389
Since: 6.9.3.0

ldap.contact.Name.searchattr

Module: cmas-core-security
Description: Attribute to search for the contact DN by LDAP ID (e.g. uid).
Type: string
Restart required: no
System: no
Optional: yes
Example value: uid
Since: 6.9.3.0

ldap.contact.Name.userdn

Module: cmas-core-security
Description: User DN to look up contact DN by LDAP ID. If not set, the anonymous account is used.
Type: string
Restart required: no
System: no
Optional: yes
Since: 6.9.3.0

ldap.initialcontextfactory

Module: cmas-core-security
Description: Class name for the initial context factory of the LDAP implementation when using LDAP authentication. Usually this is com.sun.jndi.ldap.LdapCtxFactory.
Type: string
Restart required: yes
System: yes
Optional: no
Example value: com.sun.jndi.ldap.LdapCtxFactory
Since: 6.0

Email Configuration

Outgoing Email

mail.smtp.email

Module: cmas-core-server
Description: SMTP URL for outgoing emails
Type: string
Restart required: no
System: yes
Optional: no
Example value: smtp://mail.mydomain.com:25
Since: 6.0

mail.smtp.envelopesender

Module: cmas-core-server
Description: Email address used as a sender in SMTP envelope. If not set, the From address of the email is used.
Type: string
Restart required: no
System: yes
Optional: no
Example value: mysender@mydomain.com
Since: 6.5.7

mail.from

Module: cmweb-server-adapter
Description: Central sender address to be used for email communication. The value set here appears as sender of emails sent from ConSol CM.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: consolcm@example.com
Since: 6.1.2

mail.reply.to

Module: cmweb-server-adapter
Description: Central reply-to address to be used for email communication. The value set here controls the reply-to header of emails sent from ConSol CM.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: consolcm@example.com
Since: 6.0.1

mailTemplateAboveQuotedText

Module: cmweb-server-adapter
Description: Determines the behavior of the email template in the email editor when another email is quoted, i.e. forwarded or replied to. Often used to place the signature correctly.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.2.4

mail.sender.address

Module: cmas-workflow-jbpm
Description: From address for emails from the workflow engine.
Type: string
Restart required: no
System: yes
Optional: no
Example value: myuser@consol.de
Removed in: 6.8.0
Replaced by: jobExecutor.mailFrom

mail.smtp.tls.enabled

Module: cmas-core-server
Description: Activates SMTP via SSL/TLS (SMTPS) for sending emails from the Web Client and scripts. The default value is false. If it is set to true, SMTPS is activated for sending emails.
Type: boolean
Restart required: yes
System: no
Optional: yes
Example value: true
Since: 6.11.1.6

Incoming Email

nimh.enabled

Module: cmas-core-server
Description: Enables the NIMH service which controls email polling and processing in ConSol CM. Must be suffixed with NODEID in cluster environments e.g. nimh.enabled.NODEID = true.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: false
Since: 6.9.4.0

filesystem.polling.threads.number

Module: cmas-nimh
Description: Number of threads started for polling emails from the database queue. The default value is 1.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 10
Since: 6.4.0

filesystem.polling.threads.shutdown.timeout.seconds

Module: cmas-nimh
Description: Waiting time after the shutdown signal. When the timeout is reached, the thread will be terminated.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60 (default value)
Since: 6.4.0

filesystem.polling.threads.watchdog.interval.seconds

Module: cmas-nimh
Description: Determines the interval in seconds to execute the watchdog which checks the activity of the threads of the file system poller.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 30 (default value)
Since: 6.4.0

filesystem.task.enabled

Module: cmas-nimh
Description: Allows to disable the service thread related to a given poller.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: true (default value)
Since: 6.4.0

filesystem.task.interval.seconds

Module: cmas-nimh
Description: Default interval (in seconds) for polling the file system.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60 (default value)
Since: 6.4.0

filesystem.task.polling.folder

Module: cmas-nimh
Description: Polling folder location which is scanned for emails in the format of eml files. The default value is the mail subdirectory of the ConSol CM data directory.
Type: string
Restart required: no
System: no
Optional: yes
Example value: c://cmas//mail
Since: 6.4.0

filesystem.task.timeout.seconds

Module: cmas-nimh
Description: After this time of inactivity the service thread is considered damaged and automatically restarted. The default value is 120 seconds.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

filesystem.task.transaction.timeout.seconds

Module: cmas-nimh
Description: Default transaction timeout for transactions fetching emails from the file system. Should be correlated with number of messages fetched at once.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60 (default value)
Since: 6.4.0

mailbox.<number>.name

Module: cmas-nimh
Description: Identifier (name) of the mailbox.
Type: string
Restart required: no
System: no
Optional: yes
Example value: myEmailAccount
Since: 6.11.2.0

mailbox.default.connection.host

Module: cmas-nimh
Description: Host (server name) of a given mailbox which the poller reads emails from.
Type: string
Restart required: no
System: no
Optional: yes
Example value: 10.10.1.157
Since: 6.4.0

mailbox.default.connection.password

Module: cmas-nimh
Description: Password for given mailbox which the poller reads emails from.
Type: password
Restart required: no
System: no
Optional: yes
Example value: consol
Since: 6.4.0

mailbox.default.connection.port

Module: cmas-nimh
Description: Port of a given mailbox which the poller reads emails from.
Type: string
Restart required: no
System: no
Optional: yes
Example value: 143
Since: 6.4.0

mailbox.default.connection.protocol

Module: cmas-nimh
Description: The protocol used by the email poller, e.g. IMAP or POP3.
Type: string
Restart required: no
System: no
Optional: yes
Example value: imap
Since: 6.4.0

mailbox.default.connection.username

Module: cmas-nimh
Description: User name for a given mailbox which the poller reads emails from.
Type: string
Restart required: no
System: no
Optional: yes
Example value: username
Since: 6.4.0

mailbox.default.session.mail.debug

Module: cmas-nimh
Description: JavaMail property, see JavaMail API documentation. Allows for more detailed JavaMail session debugging.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: true
Since: 6.4.0

mailbox.default.session.mail.mime.address.strict

Module: cmas-nimh
Description: JavaMail property, see JavaMail API documentation. If this property is set to false, the parsing of the email headers is less strict. Therefore, more emails with non-RFC-compliant headers will be imported into the system, instead of being stored in the email backups in the Admin Tool / Web Admin Suite.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: false (default value)
Since: 6.4.0

mailbox.default.session.mail.<PROTOCOL>.connectiontimeout

Module: cmas-nimh
Description: JavaMail property, see JavaMail API documentation. Determines the connection timeout in milliseconds.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 3000
Since: 6.4.0 (IMAP and POP3) / 6.11.2.0 (IMAPS and POP3S)

mailbox.default.session.mail.<PROTOCOL>.fetchsize

Module: cmas-nimh
Description: JavaMail property, see JavaMail API documentation. Determines the size of partial fetch in bytes for the indicated protocol.
Type: integer
Restart required: no
System: yes
Optional: yes
Example value: 1048576 (default value)
Since: 6.9.4.0 (IMAP and POP3) / 6.11.2.0 (IMAPS and POP3S)

mailbox.default.session.mail.<PROTOCOL>.partialfetch

Module: cmas-nimh
Description: JavaMail property, see JavaMail API documentation. Determines whether the protocol’s partial fetch capability should be used.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: false (default value)
Since: 6.9.4.0 (IMAP and POP3) / 6.11.2.0 (IMAPS and POP3S)

mailbox.default.session.mail.<PROTOCOL>.timeout

Module: cmas-nimh
Description: JavaMail property, see JavaMail API documentation. Determines the I/O timeout in milliseconds.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 120 for IMAP(S) and 3000 for POP3(S)
Since: 6.4.0 (IMAP and POP3), 6.11.2.0 (IMAPS and POP3S)

mailbox.default.task.delete.read.messages

Module: cmas-nimh
Description: Defines whether messages should be removed from the mailbox after processing. For the IMAP protocol messages are marked as SEEN by default. For the POP3 protocol, this property is ignored and the emails are always deleted from the email server after they were processed successfully.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: false (default value)
Since: 6.4.0, changed in 6.12.1.0

mailbox.default.task.enabled

Module: cmas-nimh
Description: With this property, the service thread related to the given poller can be disabled.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: true (default value)
Since: 6.4.0

mailbox.default.task.interval.seconds

Module: cmas-nimh
Description: Default interval (in seconds) for polling mailboxes.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60 (default value)
Since: 6.4.0

mailbox.default.task.max.message.size

Module: cmas-nimh
Description: Maximum size of email messages (i.e., email plus attachment). Emails exceeding the size limit will not be automatically processed by NIMH but will be stored in the database (table cmas_nimh_archived_mail) and will therefore appear in the email backups in the Admin Tool / Web Admin Suite. From there they can be resent, downloaded to the file system, or deleted. For those operations the message size is not relevant.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 10485760 (default value, 10 MB)
Since: 6.4.0

mailbox.default.task.max.messages.per.run

Module: cmas-nimh
Description: Number of messages fetched at once from the mailbox. Must be correlated with the transaction timeout. The default value is 20.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

mailbox.default.task.timeout.seconds

Module: cmas-nimh
Description: After this time of inactivity the service thread is considered damaged and automatically restarted. The default value is 120 seconds.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

mailbox.default.task.transaction.timeout.seconds

Module: cmas-nimh
Description: Default transaction timeout (in seconds) for email fetching transactions. Should be correlated with number of messages fetched at once.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60 (default value)
Since: 6.4.0

mailbox.polling.threads.mail.log.enabled

Module: cmas-nimh
Description: Enables email logging which is especially crucial in cluster environments (used as semaphore there).
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: true (default value)
Since: 6.9.4.1

mailbox.polling.threads.number

Module: cmas-nimh
Description: Number of threads for accessing mailboxes.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 1 (default value)
Since: 6.4.0

mailbox.polling.unstorable.backup.folder

Module: cmas-nimh
Description: Folder on the file system which is used to store emails whose processing failed and which could not be stored in the database either. The value of the property should be the path to the data directory followed by /mail/unstorable.
Type: string
Restart required: no
System: no
Optional: yes
Example value: c:/cmas/mail/unstorable
Since: 6.11.2.7

queue.polling.threads.number

Module: cmas-nimh
Description: Number of threads started for polling the email queue in the database.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 1 (default value)
Since: 6.4.0

queue.polling.threads.shutdown.timeout.seconds

Module: cmas-nimh
Description: Waiting time after the shutdown signal for the email poller. When the timeout is reached, the thread will be terminated.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60 (default value)
Since: 6.4.0

queue.polling.threads.watchdog.interval.seconds

Module: cmas-nimh
Description: Determines the interval in seconds to execute the watchdog which checks the activity of the threads of the email queue poller.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 30 (default value)
Since: 6.4.0

queue.task.error.pause.seconds

Module: cmas-nimh
Description: Maximum number of seconds, the queue poller waits after infrastructure (e.g. database) error.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 180 (default value)
Since: 6.4.0

queue.task.interval.seconds

Module: cmas-nimh
Description: Determines the interval in seconds for the main email queue polling thread.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 15 (default value)
Since: 6.4.0

queue.task.max.retries

Module: cmas-nimh
Description: Maximum number of email processing retries after an exception. When reached, the email is moved to the email archive. This email can be rescheduled again using the NIMH API or the Admin Tool / Web Admin Suite.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 10
Since: 6.4.0

queue.task.timeout.seconds

Module: cmas-nimh
Description: After this time of inactivity (in seconds), the service thread is considered damaged and automatically restarted.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 600 (default value)
Since: 6.4.0

queue.task.transaction.timeout.seconds

Module: cmas-nimh
Description: Transaction timeout (in seconds) for email processing in the pipe.
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60 (default value)
Since: 6.4.0

mail.attachments.validation.info.sender

Module: cmas-nimh-extension
Description: Sets the From header for error notification emails which are sent when the validation of the attachment type fails.
Type: string
Restart required: no
System: yes
Optional: no
Example value: admin@mail.com
Since: 6.7.5

mail.attachments.validation.info.subject

Module: cmas-nimh-extension
Description: Sets the subject for error notification emails which are sent when the validation of the attachment type fails.
Type: string
Restart required: no
System: yes
Optional: no
Example value: Email was not processed because its attachments were rejected!
Since: 6.7.5

mail.db.archive

Module: cmas-nimh-extension
Description: If property is set to true, incoming emails are automatically archived in the database.
Type: boolean
Restart required: no
System: yes
Optional: yes
Example value: false (default value)
Since: 6.8.5.5

mail.error.from.address

Module: cmas-nimh-extension
Description: Sets the From address for error notification emails which are sent when the email processing fails.
Type: email
Restart required: no
System: yes
Optional: no
Example value: myuser@consol.de
Since: 6.4.0

mail.error.to.address

Module: cmas-nimh-extension
Description: Sets the To address for error notification emails which are sent when the email processing fails. As a default the value of the property admin.email is used.
Type: email
Restart required: no
System: yes
Optional: no
Example value: myuser@consol.de
Since: 6.4.0

mail.on.error

Module: cmas-nimh-extension
Description: If set to true, an error notification email is sent to the configured address if an email could not be processed.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: true (default)
Since: 6.4.0

mail.ticketname.pattern

Module: cmas-nimh-extension
Description: Regular expression pattern used to identify the ticket name in the subject of incoming mails.
Type: string
Restart required: no
System: yes
Optional: no
Example value: .*?Ticket\s+\((\S+)\).*
Since: 6.4.0
Removed in: 6.12.0.5

Attachments for Incoming Emails

attachment.allowed.types

Module: cmas-core-server
Description: Comma-separated list of allowed attachment file types. By default, only images, PDF and text files are allowed. If no value is provided, all files are allowed (not recommended)

The property is not considered for attachments added with CM/Doc, i.e. it is not required to allow docx as a file extension for attachments in order to use CM/Doc.
Type: string
Restart required: no
System: yes
Optional: no
Example value: jpg,jpeg,gif,bmp,png,pdf,txt
Since: 6.5.0, modified in 6.13.0.8

attachment.max.size

Module: cmas-core-server
Description: Maximum attachment size, in MB. This property controls the size of attachments at tickets, customers, and resources. It also controls the size of incoming (not outgoing) email attachments. The value of this property needs to be aligned with the respective setting in the application server configuration (add the parameter max-post-size to the http listener in cm6.xml, cm6-cmrf.xml or domain.xml). In addition you might need to increase the value of cmas-nimh, mailbox.default.task.max.message.size. The value of this property is displayed in the Web Client when adding a new attachment.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 100 (default value)
Since: 6.4.0

Email Encryption (Outgoing and Incoming)

These settings only apply if email encryption is active (true).

mail.encryption

Module: cmas-core-server
Description: If the property is set to true, the encryption checkbox in the email editor of the Web Client is checked by default. The default value of the property is false.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: true
Since: 6.8.4.0

In case certificates are stored in an LDAP directory, the following settings have to be made:

ldap.certificate.basedn

Module: cmas-core-server
Description: Base DN for the certificate location in the LDAP tree. Since version 6.14.0.0 this property is mandatory. In earlier CM versions, if not set, the value of the property cmas-core-security, ldap.basedn is used.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: ou=accounts,dc=consol,dc=de
Since: 6.8.4

ldap.certificate.content.attribute

Module: cmas-core-server
Description: Name of the LDAP attribute where the certificate data is stored in the LDAP tree.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: usercertificate (default value)
Since: 6.8.4

ldap.certificate.password

Module: cmas-core-server
Description: Password of the LDAP certificate manager. Since version 6.14.0.0 this property is mandatory. In earlier CM versions, if not set, the value of the property cmas-core-security, ldap.password is used.
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.8.4

ldap.certificate.providerurl

Module: cmas-core-server
Description: URL of the LDAP certificate provider. Since version 6.14.0.0 this property is mandatory. In earlier CM versions, if not set, the value of the property cmas-core-security, ldap.providerurl is used.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: ldap://myserver.consol.de:389
Since: 6.8.4

ldap.certificate.searchattr

Module: cmas-core-server
Description: LDAP attribute name used to search for certificates in the LDAP tree.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: mail (default value)
Since: 6.8.4

ldap.certificate.userdn

Module: cmas-core-server
Description: DN of the LDAP certificate manager. Since version 6.14.0.0 this property is mandatory. In earlier CM versions, if not set, the value of the property cmas-core-security, ldap.userdn is used.
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.8.4

Activity Interval Configuration

admin.tool.session.check.interval

Module: cmas-app-admin-tool
Description: Configures the time interval (in seconds) in which the system checks for inactive (ended) Admin Tool sessions.
Type: integer
Restart required: yes
System: yes
Optional: no
Example value: 30
Since: 6.7.5

server.session.timeout

Module: cmas-core-server
Description: Server session timeout (in seconds) for connected clients (database table cmas_user_session). Each client can overwrite this timeout with custom value using its ID (ADMIN_TOOL, WEB_CLIENT, WORKFLOW_EDITOR, TRACK, ETL, REST, WAS) appended to property name, e.g., server.session.timeout.WAS.
Please see also the page customization attributes updateTimeServerSessionActivityEnabled and updateTimeServerSessionActivity, both of type cmApplicationCustomization.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1800
Since: 6.6.1, 6.7.1

Detailed explanation for the Admin Tool:

server.session.timeout.ADMIN_TOOL
Defines the time interval how long the server considers a session valid while there is no activity from the Admin Tool holding the session. The Admin Tool is not aware of this value, it only suffers having an invalid session, if the last activity has been longer in the past.
admin.tool.session.check.interval
Defines the time between two checks done by the Admin Tool, if the server still considers its session valid.

For example, if admin.tool.session.check.interval = 60, the Admin Tool queries the server every minute if its session is still active/valid. In case server.session.timeout.ADMIN_TOOL = 600 the Admin Tool will get the response that the session is now invalid after ten minutes of inactivity.

HTTP Header Configuration

It is possible to configure the HTTP response header returned with the web page in the Web Client. This allows, for example, to define security-related response headers according to the requirements dictated by policy or environment. These properties are managed in the module cmweb-server-http-headers. The name of the property is the field of the response header and the value of the property is the field value sent in the header.

Both name and value must match the exact spelling of the HTTP specification for the desired response header field. The correct interpretation and handling of the header lies in the responsibility of the client browser.

Example Property: X-Frame-Options

Module: cmweb-server-http-headers
Description: Example property to illustrate the configuration of HTTP headers. In this case the delivered HTTP header contains the field X-Frame-Options with the value SAMEORIGIN.
Each property in the module cmweb-server-http-headers represents one header field. The property name/key identifies the response header field and the value of the property is the field value sent in this header.
Please be aware that additional HTTP response headers must be correctly defined with the exact spelling as officially specified! Please note also that the correct interpretation and application of these headers is fully in the realm and responsibility of the client browser which requested the page!
Type: string
Restart required: no
System: no
Optional: yes
Example value: SAMEORIGIN
Since: 6.10.8

Authentication protection

The authentication protection feature protects the ConSol CM system against brute force attacks. It covers database and LDAP authentication for all authentication endpoints:

User authentication in the Web Client, Web Admin Suite, Admin Tool and Process Designer
Contact authentication in CM/Track using the REST API
Authentication of webhooks

All failed login attempts are logged in the database and the account is blocked after a defined number of failed attempts for a certain time period. A notification email is sent to the administrator and to the affected user.

Not all failed login attempts are due to brute-force attacks. A failed attempt is also logged if the affected account is deactivated or configured incorrectly. The reason of the failed attempt is shown in the Web Admin Suite. If the login fails due to problems with the LDAP server (authentication methods LDAP and DATABASE,LDAP only), the account is not blocked.

Accounts can be unblocked either automatically after a defined time period or manually, either in the Web Admin Suite or using an unblock link.

brute.force.admin.auth.failures.notify.amount

Module: cmas-core-security
Description: Defines the number of unsuccessful authentication attempts after which the administrator will be notified. The default value is 100.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 100
Since: 6.14.0

brute.force.admin.auth.failures.notify.period

Module: cmas-core-security
Description: Defines the period in minutes for checking for failed authentication attempts to inform the administrator. If more failed authentication attempts than defined in brute.force.admin.auth.failures.notify.amount occur in this timeframe, the administrator is notified about this via email. The default value is 60.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 60
Since: 6.14.0

brute.force.attempts.to.block

Module: cmas-core-security
Description: Defines the number of unsuccessful authentication attempts after which an account will be blocked. The default value is 7.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 7
Since: 6.14.0

brute.force.auto.unblock.active

Module: cmas-core-security
Description: Determines if the mechanism to automatically unblock an account after a certain time period is enabled. The default value is true.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: true
Since: 6.14.0

brute.force.auto.unblock.period

Module: cmas-core-security
Description: Defines the period in minutes after which an account is automatically unblocked. The default value is 30.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 30
Since: 6.14.0

brute.force.endpoint.blocking.active

Module: cmas-core-security
Description: Determines if the authentication protection feature is enabled for webhooks. The default value is true.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: true
Since: 6.14.0

brute.force.engineer.blocking.active

Module: cmas-core-security
Description: Determines if the authentication protection feature is enabled for users. The default value is true.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: true
Since: 6.14.0

brute.force.mail.notification.active

Module: cmas-core-security
Description: Determines if users and contacts who were blocked receive an email with a link to unblock their accounts. The administrator receives emails with information about blocked accounts and the unblock codes for these accounts. In addition, the administrator receives alerts if the number of failed attempts exceeds the value set in brute.force.admin.auth.failures.notify.amount. The default value is false.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.14.0

brute.force.period.between.attempts.to.block

Module: cmas-core-security
Description: Defines the period in minutes for checking for failed authentication attempts. If more failed authentication attempts than defined in brute.force.attempts.to.block occur in this timeframe, the user or endpoint is blocked. The default value is 1.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1
Since: 6.14.0

brute.force.unblock.code.expiration.period

Module: cmas-core-security
Description: Defines the period in hours after which the unblock code will expire. The default value is 24.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 24
Since: 6.14.0

brute.force.unit.blocking.active

Module: cmas-core-security
Description: Determines if the authentication protection feature is enabled for contacts / REST users. The default value is true.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: true
Since: 6.14.0