You are here:

List of System Properties by Area

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

CMRF & DWH Configuration
Indexer and Search Configuration
List of System Properties by Area
E-Mail Configuration
Activity Interval Configuration
Administrator E-Mail Addresses

CMRF & DWH Configuration

autocommit.cf.changes

Module: cmas-dwh-server
Description: Defines whether DWH tasks which result from configurational changes on Custom 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
Since: 6.7.0

batch-commit-interval

Module: cmas-dwh-server
Description: Number of objects in a JMS message. Larger values mean better transfer performance at the cost of higher memory usage.
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. Possible values are DIRECT (database communication channel, default value since 6.9.4.1), JMS (default value before 6.9.4.1). Before 6.9.4.1 it has to be manually added.
Type: string
Restart required: no
System: yes
Optional: no
Example value: DIRECT
Since: 6.8.5.0
Removed in: 6.11.0.0

dwh.mode

Module: cmas-dwh-server
Description: Current mode for 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

is.cmrf.alive

Module: cmas-dwh-server
Description: As a starting point, the time the last message was sent to CMRF should be used. If a response from CMRF is not received after value (in seconds), it should create a DWH operation status with an error message indicating that CMRF is down.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1200
Since: 6.7.0

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: Text for error e-mails 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: From address for error e-mails from the DWH
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.0.1

notification.error.subject

Module: cmas-dwh-server
Description: Subject for error e-mails 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: To address for error e-mails 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: Text for e-mails 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: From address for e-mails from the DWH when a transfer finishes successfully.
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.0.1

notification.finished_successfully.subject

Module: cmas-dwh-server
Description: Subject for e-mails 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: To address for e-mails 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: Text for e-mails 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: From address for e-mails from the DWH when a transfer finishes unsuccessfully.
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.0.1

notification.finished_unsuccessfully.subject

Module: cmas-dwh-server
Description: Subject for e-mails 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: To address for e-mails 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: E-mail (SMTP) server hostname for sending DWH e-mails.
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: Password for sending DWH e-mails (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 e-mails.
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 e-mails from the DWH.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: pop3\

notification.username

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

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 not to 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

unit.transfer.order

Module: cmas-dwh-server
Description: Define in which order Data Object 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 lower priority than normal tasks.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 15 (default)
Since: 6.8.3

database.notification.enabled

Module: cmas-core-index-common
Description: Indicates whether index update database notification channel should be used instead of JMS.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.8.4.7

database.notification.redelivery.delay.seconds

Module: cmas-core-index-common
Description: In case of index update database notification channel, indicates notification redelivery delay 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: In case of index update database notification channel, 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: All tasks created for index update will be automatically executed right after creation.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.6.1

index.attachment

Module: cmas-core-index-common
Description: Specifies whether 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: Specifies whether unit and ticket history are 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: Status of the Indexer, possible values RED, YELLOW, GREEN, will be displayed in the Admin Tool.
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: How many threads will be used to execute index tasks (synchronization, administrative, and repair tasks).
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1 (default) (we recommend to use a value not larger than 2)
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 current (possibly old) index version.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1 (default)
Since: 6.7.0

index.version.newest

Module: cmas-core-index-common
Description: Holds information about which index version is considered newest.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 1 (default)
Since: 6.7.0

indexed.assets.per.thread.in.memory

Module: cmas-core-index-common
Description: 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)
Since: 6.8.0

indexed.engineers.per.thread.in.memory

Module: cmas-core-index-common
Description: How many engineers should be loaded into memory at once, per thread, during indexing.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 300 (default)
Since: 6.6.14, 6.7.3

indexed.resources.per.thread.in.memory

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

indexed.tickets.per.thread.in.memory

Module: cmas-core-index-common
Description: How many tickets should be loaded into memory at once, per thread, during indexing.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 100 (default)
Since: 6.6.14, 6.7.3

indexed.units.per.thread.in.memory

Module: cmas-core-index-common
Description: How many units should be loaded into memory at once, per thread, during indexing.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 200 (default)
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. Default null. Since 6.6.17 this value is configurable in set-up to designate the initial indexing master server. Please note that changing this value is only allowed when all cluster nodes' index change receivers are stopped.
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.
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.
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: How long the master server may continually fail until a new master gets elected. Default 5. Since 6.6.17 this value is configurable in set-up, where zero means that master server will never change (failover is disabled).
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 5
Since: 6.6.0

synchronize.megabits.per.second

Module: cmas-core-index-common
Description: How much bandwidth the master server may consume when transferring index changes to all slave servers. Default 85. Please 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
Since: 6.6.0

synchronize.sleep.millis

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

Search Results

globalSearchResultSizeLimit

Module: cmweb-server-adapter
Description: Maximum number of items in Quick Search result.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 10
Since: 6.0

searchPageSize

Module: cmweb-server-adapter
Description: Default page size for search results.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 20
Since: 6.0

searchPageSizeOptions

Module: cmweb-server-adapter
Description: Options for page size for search results.
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: Maximum number of units in unit search result (e.g. when searching for contact).
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:

authentication.method

Module: cmas-core-security
Description: User authentication method (internal CM database or LDAP authentication). Allowed values are LDAP or DATABASE.
Type: string
Restart required: no
System: yes
Optional: no
Example value: DATABASE
Since: 6.0

ldap.authentication

Module: cmas-core-security
Description: Authentication method used when using LDAP authentication.
Type: string
Restart required: yes
System: yes
Optional: no
Example value: simple
Since: 6.0

ldap.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.0

ldap.initialcontextfactory

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

ldap.password

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

ldap.providerurl

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

ldap.searchattr

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

ldap.userdn

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

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: Indicates contact authentication method, where possible values are DATABASE or LDAP or LDAP,DATABASE or DATABASE,LDAP.
Type: string
Restart required: no
System: yes
Optional: no
Since: 6.9.3.0

ldap.contact.name.basedn

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

ldap.contact.name.password

Module: cmas-core-security
Description: Password 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.contact.name.providerurl

Module: cmas-core-security
Description: Address of the LDAP server (ldap[s]://host:port).
Type: string
Restart required: no
System: no
Optional: yes
Since: 6.9.3.0

ldap.contact.name.searchattr

Module: cmas-core-security
Description: Attribute to search for contact DN by LDAP ID (e.g. uid).
Type: string
Restart required: no
System: no
Optional: yes
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. If it is not set, com.sun.jndi.ldap.LdapCtxFactory is used.
Type: string
Restart required: yes
System: yes
Optional: no
Example value: com.sun.jndi.ldap.LdapCtxFactory
Since: 6.0

E-Mail Configuration

Outgoing E-Mail

Independent of incoming e-mail mode (Mule/ESB and NIMH).

mail.smtp.email

Module: cmas-core-server
Description: SMTP e-mail URL for outgoing e-mails
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: E-mail address used as sender in SMTP envelope. If not set, the From address of the e-mail 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: Use this address if set instead of engineer e-mail address during e-mail conversation.
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.1.2

mail.reply.to

Module: cmweb-server-adapter
Description: When set, Web Client will display Reply-To field on e-mail send, prefilled with this value.
Type: string
Restart required: no
System: yes
Optional: yes
Since: 6.0.1

Please read the detailed information about ConSol CM Reply-To addresses in section Scripts of Type E-Mail.

mailTemplateAboveQuotedText

Module: cmweb-server-adapter
Description: Indicates behavior of e-mail template in the Ticket E-Mail Editor when another e-mail 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 e-mails 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

Incoming E-Mail

Settings for Mule/ESB

esb.directory

Module: cmas-esb-core
Description: Directory used by Mule/ESB.
Type: string
Restart required: no
System: yes
Optional: no
Example value: C:\Users\user\cmas\mule
Since: 6.0
Removed in: 6.11.0

mail.attachments.validation.info.sender

Module: cmas-esb-mail
Description: Sets From header of attachments type error notification e-mail. As a default the e-mail address of the administrator which you have entered during system set-up is used.
Type: string
Restart required: no
System: yes
Optional: no
Example value: admin@consolcm.com
Since: 6.7.5
Removed in: 6.11.0

mail.attachments.validation.info.subject

Module: cmas-esb-mail
Description: Sets subject of attachments type error notification e-mail.
Type: string
Restart required: no
System: yes
Optional: no
Example value: E-mail was not processed because its attachments were rejected!
Since: 6.7.5
Removed in: 6.11.0

mail.callname.pattern

Module: cmas-esb-mail
Description: Regular expression for subject of incoming e-mails. Available as TICKET_NAME_PATTERN_FORMAT in incoming e-mail scripts.
Type: string
Restart required: no
System: yes
Optional: no
Example value: .*?Ticket\s+\((\S+)\).*
Since: 6.0
Removed in: 6.11.0

mail.cluster.node.id

Module: cmas-esb-mail
Description: Only the node whose mail.cluster.node.id equals cmas.clusternode.id will start the Mule/ESB e-mail services.
Type: string
Restart required: no
System: yes
Optional: no
Example value: unspecified
Since: 6.6.5
Removed in: 6.11.0

mail.db.archive

Module: cmas-esb-mail
Description: If property is set to true, incoming e-mails are archived in the database.
Type: boolean
Restart required: no
System: yes
Optional: yes
Example value: false (default)
Since: 6.8.5.5
Removed in: 6.11.0

Obsolete! In Mule/ESB mode, no e-mails are saved in the database. E-mails which could not be processed are stored in the file system, see section E-Mail Backups.

mail.delete.read

Module: cmas-esb-mail
Description: Determines whether CM deletes messages fetched via IMAP(S). Setting value to true will cause deletion of messages after fetching. Default is to not delete messages fetched via IMAP(S). Note: Messages fetched via POP3(S) will always be deleted.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: true
Since: 6.7.3
Removed in: 6.11.0

mail.incoming.uri

Module: cmas-esb-mail
Description: URL for incoming e-mails.
Type: string
Restart required: no
System: yes
Optional: no
Example value: pop3://cm-incoming-user:password@localhost:10110
Since: 6.0
Removed in: 6.11.0

This value should not be edited here using the system properties pop-up window, but the mailboxes should be configured using the navigation item E-mail. Using this standard feature all entries are controlled - i.e., for each mailbox which is added, CM establishes a test connection during mailbox set-up. That way it is not possible to enter wrong values.

mail.max.restarts

Module: cmas-esb-mail
Description: Maximum number of e-mail service restarts before giving up.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 3
Since: 6.0
Removed in: 6.11.0

mail.mime.strict

Module: cmas-esb-mail
Description: If set to false, e-mail addresses are not parsed for strict MIME compliance. Default is true, which means check for strict MIME compliance.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: false
Since: 6.6.17, 6.7.3
Removed in: 6.11.0

mail.mule.service

Module: cmas-esb-mail
Description: From address for e-mails sent by Mule service
Type: email
Restart required: no
System: yes
Optional: no
Example value: myuser@consol.de
Since: 6.0
Removed in: 6.11.0

mail.polling.interval

Module: cmas-esb-mail
Description: E-mail polling interval in ms.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 60000
Since: 6.0
Removed in: 6.11.0

mail.process.error

Module: cmas-esb-mail
Description: To address for error e-mails from Mule. As a default the e-mail address of the administrator which you have entered during system set-up is used.
Type: email
Restart required: no
System: yes
Optional: no
Example value: myuser@consol.de
Since: 6.0
Removed in: 6.11.0

mail.process.retry.attempts

Module: cmas-esb-mail
Description: Number of retries when processing e-mail
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 3
Since: 6.0.2
Removed in: 6.11.0

mail.process.timeout

Module: cmas-esb-mail
Description: E-mail processing timeout in seconds.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 60
Since: 6.1.3
Removed in: 6.11.0

mail.redelivery.retry.count

Module: cmas-esb-mail
Description: Indicates the number of retries of re-delivering an e-mail from the CM system.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 3
Since: 6.1.0
Removed in: 6.11.0

Settings for NIMH

Those settings apply if NIMH is enabled (and therefore Mule/ESB is disabled):

nimh.enabled

Module: cmas-core-server
Description: Enables NIMH service. Must be suffixed with the cluster node ID, 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 db e-mails' queue polling. Default: 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 reached, thread will be terminated. Default: 60
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

filesystem.polling.threads.watchdog.interval.seconds

Module: cmas-nimh
Description: Watchdog thread interval. Default: 30
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

filesystem.task.enabled

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

filesystem.task.interval.seconds

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

filesystem.task.polling.folder

Module: cmas-nimh
Description: Polling folder location which will be scanned for e-mails in the format of eml files. Default: "mail" subdir of cmas 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 as damaged and automatically restarted. Default: 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 e-mail fetching transactions. Should be correlated with number of messages fetched at once. Default: 60 seconds
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

mailbox.1.connection.host

Module: cmas-nimh
Description: Host (server) for first configured mailbox. Will overwrite the default parameter mailbox.default.connection.host.

mailbox.1.connection.password

Module: cmas-nimh
Description: Password for first configured mailbox. Will overwrite the default parameter mailbox.default.connection.password.

mailbox.1.connection.port

Module: cmas-nimh
Description: Port for first configured mailbox. Will overwrite the default parameter mailbox.default.connection.port.

mailbox.1.connection.protocol

Module: cmas-nimh
Description: Protocol (e.g., IMAP or POP3) for first configured mailbox. Will overwrite the default parameter mailbox.default.connection.protocol.

mailbox.1.connection.username

Module: cmas-nimh
Description: User name for first configured mailbox. Will overwrite the default parameter mailbox.default.connection.username.

mailbox.2.connection.host

Module: cmas-nimh
Description: Host (server) for second configured mailbox. Will overwrite the default parameter mailbox.default.connection.host.

mailbox.2.connection.password

Module: cmas-nimh
Description: Password for second configured mailbox. Will overwrite the default parameter mailbox.default.connection.password.

mailbox.2.connection.port

Module: cmas-nimh
Description: Port for second configured mailbox. Will overwrite the default parameter mailbox.default.connection.port.

mailbox.2.connection.protocol

Module: cmas-nimh
Description: Protocol (e.g., IMAP or POP3) for second configured mailbox. Will overwrite the default parameter mailbox.default.connection.protocol.

mailbox.2.connection.username

Module: cmas-nimh
Description: User name for second configured mailbox. Will overwrite the default parameter mailbox.default.connection.username.

For all NIMH-related mailbox properties, the following principle is used: a default property is defined (e.g. mailbox.default.connection.port). If no mailbox-specific value is configured, this default value will be used.

mailbox.default.connection.host

Module: cmas-nimh
Description: Host (server name) of a given mailbox from which the poller reads e-mails.
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 from which the poller reads e-mails.
Type: string
Restart required: no
System: no
Optional: yes
Example value: consol
Since: 6.4.0

mailbox.default.connection.port

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

mailbox.default.connection.protocol

Module: cmas-nimh
Description: Poller's protocol e.g., IMAP or POP3. No default value
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 from which the poller reads e-mails.
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: Example javax.mail property - allows for more detailed javax.mail session debugging
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: true
Since: 6.4.0

mailbox.default.session.mail.imap.timeout

Module: cmas-nimh
Description: Example javax.mail property
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 120
Since: 6.4.0

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

Module: cmas-nimh
Description: Example javax.mail property - counterpart of the old mule mail.mime.strict, allows to set not so strict e-mail header parsing
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: true
Since: 6.4.0

mailbox.default.session.mail.pop3.timeout

Module: cmas-nimh
Description: Example javax.mail property.
Type:
Restart required:
System:
Optional:
Example value:
Since: 6.4.0

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

Module: cmas-nimh
Description: e.g. mailbox.default.session.mail.imaps.partialfetch
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: false
Since: 6.10

mailbox.default.task.delete.read.messages

Module: cmas-nimh
Description: This defines whether messages should be removed from the mailbox after processing. For IMAP protocol messages are marked as SEEN by default. For POP3 protocol, when flag is set to true the message is removed, otherwise remains on server and will result in infinite reads. Default: false.
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: false
Since: 6.4.0

mailbox.default.task.enabled

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

mailbox.default.task.interval.seconds

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

mailbox.default.task.max.message.size

Module: cmas-nimh
Description: Maximum size of e-mail messages (i.e., e-mail plus attachment). E-mails 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 e-mail backups in the Admin Tool (see section E-Mail Backups). From there they can be resent, downloaded to the file system, or deleted. For those operations the message size is not relevant. Default is set to 10MB: 10485760
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 10485760
Since: 6.4.0

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

Module: cmas-nimh
Description: Number of messages fetched at once from mailbox. Must be correlated with transaction timeout. Default set to: 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 as damaged and automatically restarted. Default: 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 for e-mail fetching transactions. Should be correlated with number of messages fetched at once. Default: 60 seconds
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

mailbox.polling.threads.mail.log.enabled

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

mailbox.polling.threads.number

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

queue.polling.threads.number

Module: cmas-nimh
Description: Number of threads started for e-mails' queue polling. Default: 1
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 1
Since: 6.4.0

queue.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. Default: 60
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

queue.polling.threads.watchdog.interval.seconds

Module: cmas-nimh
Description: Watchdog thread interval. Default: 30
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 30
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. Default 180 seconds
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 180
Since: 6.4.0

queue.task.interval.seconds

Module: cmas-nimh
Description: Main e-mails' queue polling thread interval. Default: 15
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 15
Since: 6.4.0

queue.task.max.retries

Module: cmas-nimh
Description: Maximum number of e-mail processing retries after an exception. When reached, the e-mail is moved to the e-mail archive. This e-mail can be rescheduled again using NIMH API (or the Admin Tool).
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) the service thread is considered as damaged and automatically restarted. Default: 600 seconds
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 600
Since: 6.4.0

queue.task.transaction.timeout.seconds

Module: cmas-nimh
Description: Transaction timeout for e-mail processing in the pipe. Default: 60
Type: integer
Restart required: no
System: no
Optional: yes
Example value: 60
Since: 6.4.0

mail.attachments.validation.info.sender

Module: cmas-nimh-extension
Description: Sets From header of attachments type error notification mail
Type: string
Restart required: no
System: yes
Optional: no
Example value: admin@mail.com
Since: 6.7.5

This is an equivalent to the old cmas-esb-mail, mail.attachments.validation.info.sender

mail.attachments.validation.info.subject

Module: cmas-nimh-extension
Description: Sets subject of attachments type error notification mail.
Type: string
Restart required: no
System: yes
Optional: no
Example value: E-mail was not processed because its attachments were rejected!
Since: 6.7.5

This is an equivalent to the old cmas-esb-mail, mail.attachments.validation.info.subject

mail.db.archive

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

mail.error.from.address

This is an equivalent to the old cmas-esb-mail,mail.mule.service

mail.error.to.address

This is an equivalent to the old cmas-esb-mail, mail.process.error

mail.on.error

Module: cmas-nimh-extension
Description: If set to true an error e-mail is sent to the above configured address in case the e-mail message could not be processed. Default: true
Type: boolean
Restart required: no
System: no
Optional: yes
Example value: false
Since: 6.4.0

mail.process.error

Module: cmas-nimh-extension
Description: To address for error e-mails from Mule.
Type: email
Restart required: no
System: yes
Optional: no
Example value: myuser@consol.de
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

Mapping of Former Mule and New NIMH Properties

Mule property	NIMH property
`cmas-esb-mail, mail.delete.read`	`cmas-nimh, mailbox.default.task.delete.read.messages`
`cmas-esb-mail, mail.polling.interval`	`cmas-nimh, mailbox.default.task.interval.seconds`
`cmas-esb-mail, mail.process.retry.attempts`	`cmas-nimh, queue.task.max.retries`
`cmas-esb-mail, mail.mime.strict`	`cmas-nimh, mailbox.default.session.mail.mime.address.strict`
`cmas-esb-mail, mail.encryption`	`cmas-core-server, mail.encryption` (moved to core server properties)
`cmas-esb-mail, mail.callname.pattern`	`cmas-nimh-extension, mail.ticketname.pattern`
`cmas-esb-mail, mail.attachments.validation.info.sender`	`cmas-nimh-extension, mail.attachments.validation.info.sender`
`cmas-esb-mail, mail.attachments.validation.info.subject`	`cmas-nimh-extension, mail.attachments.validation.info.subject`
`(cmas-esb-mail, mail.db.archive)`	`cmas-nimh-extension, mail.db.archive`
`cmas-esb-mail, mail.mule.service`	`cmas-nimh-extension, mail.error.from.address`
`cmas-esb-mail, mail.process.error`	`cmas-nimh-extension, mail.error.to.address`

Attachments for Incoming E-Mails

These settings apply to Mule/ESB and NIMH.

attachment.allowed.types

Module: cmas-core-server
Description: Comma-separated list of allowed filename extensions (if no value defined, all file extensions are allowed).
Type: string
Restart required: no
System: yes
Optional: yes
Example value: txt,zip,doc
Since: 6.5.0

attachment.max.size

Module: cmas-core-server
Description: Maximum attachment size, in MB. This is a validation property of the CM API. It controls the size of attachments at tickets, at units, and at resources. It also controls the size of incoming (not outgoing!) e-mail attachments in NIMH as well as in Mule/ESB mode.
Type: integer
Restart required: no
System: yes
Optional: no
Example value: 100
Since: 6.4.0

E-Mail Encryption (Outgoing and Incoming)

These settings only apply if e-mail encryption is active (true). This is valid for Mule/ESB Mail and NIMH.

mail.encryption

Module: cmas-core-server
Description: If property is set to true, the encrypt checkbox in the Ticket E-Mail Editor is checked by default.
Type: boolean
Restart required: no
System: yes
Optional: no
Example value: true (default = false)
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 certificates location in the LDAP tree. If not provided, 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: LDAP attribute name used where certificate data is stored in the LDAP tree. Default value: usercertificate
Type: string
Restart required: no
System: yes
Optional: yes
Example value: usercertificate
Since: 6.8.4

ldap.certificate.password

Module: cmas-core-server
Description: LDAP Certificates manager password. If not set, 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: LDAP Certificates provider URL. If not set, cmas-core-security, ldap.providerurl is used.
Type: string
Restart required: no
System: yes
Optional: yes
Example value: ldap://ldap.consol.de:389
Since: 6.8.4

ldap.certificate.searchattr

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

ldap.certificate.userdn

Module: cmas-core-server
Description: LDAP Certificates manager DN. If not set, 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: Admin Tool inactive (ended) sessions check time interval (in seconds)
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. Each client can overwrite this timeout with custom value using its ID (ADMIN_TOOL, WEB_CLIENT, WORKFLOW_EDITOR, TRACK (before 6.8, please use PORTER), ETL, REST) appended to property name, e.g., server.session.timeout.ADMIN_TOOL.
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.

Administrator E-Mail Addresses

ConSol CM can use different administrator e-mail addresses, depending on the subsystem. Please see Administrator and Notification E-Mail Addresses for detailed explanations concerning admin e-mail addresses. If no specific admin e-mail addresses are configured, the global admin e-mail address (that you have defined during system set-up) is used.