List of System Properties by Module

This chapter lists the system properties included in the following modules.

cmas-analytics (module)

metabase.secret.key

• Module: cmas-analytics
• Description: Determines the string used by the JWT signing key. Needs to match the setting String used by the JWT signing key in the Metabase configuration.
• Type: string
• Restart required: no
• System: no
• Optional: no
• Example value: 50e2230c98344f183c996e6a3954c1a1e43ed100cc36f4ea093800aa2d8a1075
• Since: 6.13.0.0

metabase.url

• Module: cmas-analytics
• Description: Determines the URL where the Metabase application runs. Needs to match the setting Site URL in the Metabase configuration.
• Type: string
• Restart required: no
• System: no
• Optional: no
• Example value: http://localhost:3000 (default value)
• Since: 6.13.0.0

cmas-app-admin-tool (module)

admin.tool.consumed.licences.check.interval

• Module: cmas-app-admin-tool
• Description: Sets the interval (in seconds) to monitor the number of consumed licenses.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 30 (default value)
• Since: 6.11.0.0

admin.tool.consumed.licences.pool.name

• Module: cmas-app-admin-tool
• Description: Sets the license pool name to monitor the number of consumed licenses.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: CONCURRENT_USERS (default value)
• Since: 6.11.0.0

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

autocomplete.enabled

• Module: cmas-app-admin-tool
• Description: If the flag is missing or its value is false, then the Autocomplete address navigation item is hidden in Admin Tool.
• Type: boolean
• Restart required: no
• System: yes
• Optional: yes
• Example value: true
• Since: 6.9.2.0

delete.ticket.enabled

• Module: cmas-app-admin-tool
• Description: Controls if the menu entry Delete is displayed in the context menu in the Admin Tool for the ticket list in the ticket administration.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true
• Since: 6.9.4.0

dwh.administration.refresh.interval.seconds

• Module: cmas-app-admin-tool
• Description: Internal DWH property, not to be changed manually. This property is used to set the interval for refreshing the list of actions in the Admin Tool, section Data Warehouse -> Administration -> Actions.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 10
• Since: 6.11.0.1

script.validation.interval.seconds

• Module: cmas-app-admin-tool
• Description: Interval in seconds between two code checks in the Admin Tool or the Process Designer code editor
• Type: Integer
• Restart required: no
• System: no
• Optional: no
• Example value: 1 (default value)
• Since: 6.11.0.1

start.groovy.task.enabled

• Module: cmas-app-admin-tool
• Description: For being able to run Admin Tool scripts of type Task in the Admin Tool (navigation group Services, navigation item Task Execution). It is required to enable the Start task button, which is hidden by default. This is done by setting this system property to true.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true
• Since: 6.9.4.0

task.panel.refresh.interval.seconds

• Module: cmas-app-admin-tool
• Description: Time in seconds after which the task list (in the Admin Tool) of the Task Execution Framework is refreshed.
• Type: Integer
• Restart required: no
• System: no
• Optional: no
• Example value: 10
• Since: 6.10.5.3 (not added automatically during update from versions prior to 6.10.5.3!)

cmas-archive-core-server (module)

archive.enabled

• Module: cmas-archive-core-server
• Description: Determines if GDPR-compliant deletions or anonymizations, which delete ticket or contact data from the ConSol CM database, are applied to CM/Archive as well. By default, this property is set to false, meaning that no data is deleted from CM/Archive. If you set this property to true, GDPR-compliant deletions or anonymizations are also performed in CM/Archive. This affects both already archived tickets and newly archived tickets.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.11.2.5

archive.uri

• Module: cmas-archive-core-server
• Description: Sets the URL from which the CM/Archive application can be accessed
• Type: string
• Restart required: no
• System: no
• Optional: no
• Example value: <server_url>:8090
• Since: 6.11.2.0

cmas-auth-server (module)

access.token.signing.key

• Module: cmas-auth-server
• Description: Determines the secret shared between the authorization server and all client applications using OAuth2, e.g. CM/Archive. The value of this property needs to match the value of archive.oauth2.access.token.signing.key in the configuration file of CM/Archive.
• Type: password
• Restart required: yes
• System: no
• Optional: no
• Example value: my_password
• Since: 6.11.2.0

client.archive.access.token.validity.seconds

• Module: cmas-auth-server
• Description: Determines the validity period in seconds of the access token required for using CM/Archive.
• Type: integer
• Restart required: no
• System: no
• Optional: no
• Example value: 43200 (default value)
• Since: 6.11.2.0

client.archive.enabled

• Module: cmas-auth-server
• Description: Determines if CM/Archive is enabled (true) or disabled (false).
• Type: boolean
• Restart required: no
• System: no
• Optional: no
• Example value: false
• Since: 6.11.2.0
• Removed in: 6.11.2.2

client.archive.refresh.token.validity.seconds

• Module: cmas-auth-server
• Description: Determines the validity period in seconds of the refresh token required for obtaining new access tokens for CM/Archive.
• Type: integer
• Restart required: no
• System: no
• Optional: no
• Example value: 2592000 (default value)
• Since: 6.11.2.0

client.archive.secret

• Module: cmas-auth-server
• Description: Determines the secret shared between the authorization server and CM/Archive. The value of the property needs to match the value of archive.oauth2.client.secret in the configuration file of CM/Archive.
• Type: password
• Restart required: no
• System: no
• Optional: no
• Example value: my_password
• Since: 6.11.2.0

client.was.access.token.validity.seconds

• Module: cmas-auth-server
• Description: Determines the validity period in seconds of the access token required for using the Web Admin Suite.
• Type: integer
• Restart required: no
• System: no
• Optional: no
• Example value: 43200 (default value)
• Since: 6.12.0.0

client.was.refresh.token.validity.seconds

• Module: cmas-auth-server
• Description: Determines the validity period in seconds of the refresh token required for obtaining new access tokens for the Web Admin Suite.
• Type: integer
• Restart required: no
• System: no
• Optional: no
• Example value: 2592000 (default value)
• Since: 6.12.0.0

client.was.secret

• Module: cmas-auth-server
• Description: Determines the secret shared between the authorization server and the Web Admin Suite.
• Type: password
• Restart required: no
• System: no
• Optional: no
• Example value: my_password
• Since: 6.12.0.0

cmas-core-cache (module)

cache-cluster-name

• Module: cmas-core-cache
• Description: JBoss cache cluster name.
• Type: string
• Restart required: yes
• System: yes
• Optional: no
• Example value: 635a6de1-629a-4129-8299-2d98633310f0
• Since: 6.4.0

cache.logging.listener.enabled

• Module: cmas-core-cache
• Description: Determines whether cache events are logged to infinispan.log for the standalone mode and jgroups-infinispan.log for the cluster mode.
• Type: boolean
• Restart required: yes
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.12.0.5

eviction.event.queue.size

• Module: cmas-core-cache
• Description: The size of the queue holding cache events. The default value is 200000. It is recommended to increase the value slightly (up to 400000) on systems with high traffic or load.
• Type: integer
• Restart required: yes
• System: yes
• Optional: no
• Example value: 200000 (default value)
• Since: 6.4.0

eviction.lifeSpan

• Module: cmas-core-cache
• Description: Sets the interval (in milliseconds) for cache entry validity. When this time is elapsed, the entry is removed from the cache.
• Type: integer
• Restart required: yes
• System: no
• Optional: yes
• Example value: 86400000 (default value)
• Since: 6.11.1.0

eviction.max.nodes

• Module: cmas-core-cache
• Description: Sets the maximum size of internal caches. The default value is 100000. Increasing it will lead to higher memory consumption and is not recommended unless explicitly advised by ConSol.
• Type: integer
• Restart required: yes
• System: yes
• Optional: no
• Example value: 100000 (default value)
• Since: 6.4.0

eviction.strategy

• Module: cmas-core-cache
• Description: Determines the cache eviction strategy. Please see the Infinispan documentation for details.
• Type: string
• Restart required: yes
• System: no
• Optional: yes
• Example value: LRU, LIRS (default value)
• Since: 6.11.1.0

eviction.wakeup.interval

• Module: cmas-core-cache
• Description: Sets the interval (in milliseconds) between two cache queue event processing cycles. The default value is 3000. It is recommended to decrease it (minimum is 1500) on systems with high traffic or load.
• Type: integer
• Restart required: yes
• System: yes
• Optional: no
• Example value: 3000 (default value)
• Since: 6.4.0

cmas-core-index-common (module)

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 normal tasks.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 15 (default value)
• Since: 6.8.3

database.notification.enabled

• Module: cmas-core-index-common
• Description: Indicates whether the notification channel “database” should be used for index updates instead of JMS. The default value is true.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true
• Since: 6.8.4.7
• Removed in: 6.12.0.0

database.notification.redelivery.delay.seconds

• Module: cmas-core-index-common
• Description: If the notification channel “database” is used 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: 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 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: 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). We recommend to use a value not larger than 2.
• 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 (possibly old) index version.
• 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.
• 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.
• 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.
• 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.
• 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 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 value)
• Since: 6.6.14, 6.7.3

synchronize.archive.timeout.minutes

• Module: cmas-core-index-common
• Description: Determines the time period in minutes during which index updates are archived. The default value of this property is 60 for clustered environments and 0 for non-clustered environments. If the master node is switched, 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: no
• Example value: 60
• Since: 6.12.0.0

synchronize.master.address

• Module: cmas-core-index-common
• Description: Value of -Dcmas.http.host.port specifying how to connect to the indexing master server. The default value is null. Since 6.6.17 this value is configurable in set-up to designate the initial 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.
• 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: Determines how long the master server may continually fail until a new master gets elected. Since 6.6.17, this value is configurable in setup, where 0 means that master server will never change (failover 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 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

cmas-core-security (module)

admin.email

• Module: cmas-core-security
• Description: The email address of the ConSol CM administrator. The value which you entered during system set-up is used initially.
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: myuser@consol.de
• Since: 6.0

admin.login

• Module: cmas-core-security
• Description: The name of the ConSol CM administrator. The value which you entered during system set-up is used initially.
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: admin
• Since: 6.0

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

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
• Example value: LDAP
• Since: 6.9.3.0

contact.inherit.permissions.only.to.own.customer.group

• Module: cmas-core-security
• Description: Indicates whether an authenticated contact inherits all customer group permissions from the CM/Track user profile (false) or only has permissions to his own customer group (true).
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: false
• Since: 6.9.2.3

kerberos.v5.enabled

• Module: cmas-core-security
• Description: Indicates whether SSO via Kerberos is enabled.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: false (default value if Kerberos was not enabled during system setup)
• Since: 6.2.0

kerberos.v5.username.regex

• Module: cmas-core-security
• Description: Regular expression used for mapping Kerberos principals to CM user login names.
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: (.*)@.*
• Since: 6.2.0

ldap.authentication

• Module: cmas-core-security
• Description: Authentication method used when using LDAP authentication. Possible values are anonymous and simple.
• Type: string
• Restart required: yes
• System: yes
• Optional: no
• Example value: simple (default value)
• 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.contact.name.basedn

• Module: cmas-core-security
• Description: Base path to search for 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 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
• 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 contact DN by LDAP ID.
• 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. 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

password.reset.mail.from

• Module: cmas-core-security
• Description: The From address for the email which is sent to a customer who requests a new password (using the Forgot your password? link) in CM/Track and to an engineer who requests a new password (using the Forgot your password? link) in the Web Client.
• Type: String
• Restart required: no
• System: no
• Optional: no
• Example value: mypwreset@consol.de
• Since: 6.11.0.1

policy.password.age

• Module: cmas-core-security
• Description: Maximum validity period, in number of days, example 183 (6 months), default value: 5500 (= 15 years, i.e., no password change enforced).
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 5500 (15 years, default value)
• Since: 6.10.1.0

policy.password.pattern

• Module: cmas-core-security
• Description: RegEx pattern for the password, default value: ^.{3,}$ (at least 3 characters).
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: ^.{3,}$ (default value)
• Since: 6.10.1.0

policy.rotation.ratio

• Module: cmas-core-security

• Description: Defines how often passwords may repeat. For example, setting the value to X means that the new password cannot be present among the user's X previous passwords.

  Since 6.11.2.8, this property is also taken into account for CM/Track. Nevertheless, any value greater than 1 is interpreted as 1, so that it is only possible to compare the new password to the current one.

  You can set the property to 0 to disable password rotation checks in CM/Track.

• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 1 (default value)
• Since: 6.10.1.0, changed in 6.11.2.8

policy.username.case.sensitive

• Module: cmas-core-security
• Description: Defines whether user names are case-sensitive.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true (default value)
• Since: 6.10.1.0

policy.track.username.case.sensitive

• Module: cmas-core-security
• Description: Defines whether customer (user) names in CM/Track are treated case-sensitive on login.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true (default value)
• Since: 6.11.0.0

resetCode.expirationPeriod

• Module: cmas-core-security
• Description: Defines the expiration period for the link when resetting the password in CM/Track.
• Type: Integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 86400000 (default value, 24 hours)
• Since: 6.10.1

cmas-core-server (module)

attachment.allowed.types

• Module: cmas-core-server
• Description: Comma-separated list of allowed file name extensions. If the property does not exist, all file extensions are allowed. If the property exists, but no value is provided, all file extension are blocked.
• 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 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

attachment.type.hints

• Module: cmas-core-server
• Description: Allows you to assign MIME types to not yet officially supported file extensions, so these file extensions can be detected correctly.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: 7z:application/x-7z-compressed, zip:application/zip, wav:audio/x-wav
• Since: 6.11.2.0

calendar.csv.dateFormat

• Module: cmas-core-server
• Description: Format of the date given in the csv file containing the list of holidays.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: dd/MM/yyyy
• Since: 6.9.3.2

calendar.csv.separator

• Module: cmas-core-server
• Description: Separator used in the csv file containing the list of holidays.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: ,
• Since: 6.9.3.2

config.data.version

• Module: cmas-core-server
• Description: The internal version number of the current system configuration. This property is maintained internally, please do not change it unless advised by ConSol.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 11
• Since: 6.0

config.import.global.transaction.enabled

• Module: cmas-core-server
• Description: Flag deciding whether configuration (without localizations) should be imported within a single transaction.
• Type: Boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true
• Since: 6.11.1.0

customfield.content.file.max.size

• Module: cmas-core-server
• Description: Determines the maximum size in MB of the images which can be added as content of rich text fields.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 10
• Since: 6.11.2.2

dao.log.threshold.milliseconds

• Module: cmas-core-server
• Description: Used to configure database operation times logging. DAO methods whose execution takes longer than the time set in this property (in milliseconds) are logged.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 500 (default value)
• Since: 6.11.1.0

dao.log.username

• Module: cmas-core-server
• Description: Used to configure database operation times logging. The execution of DAO methods which are related to the user name stated in this property is logged. Only one user name can be provided. The value is empty by default.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: webadmin
• Since: 6.11.1.0

defaultCommentClassName

• Module: cmas-core-server
• Description: Name of the default text class for comments.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: default_class
• Since: 6.3.0

defaultIncommingMailClassName

• Module: cmas-core-server
• Description: Name of the default text class for incoming emails.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: default_class
• Since: 6.3.0

defaultOutgoingMailClassName

• Module: cmas-core-server
• Description: Name of the default text class for outgoing emails.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: default_class
• Since: 6.3.0

engineer.description.cache.enabled

• Module: cmas-core-server
• Description: Defines whether user descriptions are cached. The default value is true, please do not change it unless advised by ConSol.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true (default value)
• Since: 6.11.0

engineer.description.mode

• Module: cmas-core-server
• Description: Defines whether user names in the ticket history are taken from the database or dynamically rendered using templates. The default value DYNAMIC is a bit more costly from the performance perspective, while PROTOCOL is faster but returns historical names which might be outdated. Use PROTOCOL if you have lots of history entries from many different users.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: PROTOCOL
• Since: 6.11.0

engineer.description.template.name

• Module: cmas-core-server
• Description: Defines the name of the template which is used to render engineer names for display in the Web Client. The template has to be stored in the Templates section of the Admin Tool.
• Type: String
• Restart required: no
• System: no
• Optional: no
• Example value: engineer description template name (default value)
• Since: 6.11.0

external.line.access.prefix

• Module: cmas-core-server
• Description: General prefix to dial before an area code. Set for each customer group separately.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 411
• Since: 6.9.3.0

fetchSize.strategy

• Module: cmas-core-server
• Description: Strategy for selecting the fetch size on JDBC result sets.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: FetchSizePageBasedStrategy, FetchSizeThresholdStrategy, FetchSizeFixedStrategy
• Since: 6.8.4.1

fetchSize.strategy.FetchSizeFixedStrategy.value

• Module: cmas-core-server
• Description: Sets fetch size value if the selected strategy to set the fetch size is FetchSizeFixedStrategy.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 150
• Since: 6.8.4.1

fetchSize.strategy.FetchSizePageBasedStrategy.limit

• Module: cmas-core-server
• Description: Sets maximum fetch size value if the selected strategy to set the fetch size is FetchSizePageBasedStrategy.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 10000
• Since: 6.8.4.1

fetchSize.strategy.FetchSizeThresholdStrategy.value

• Module: cmas-core-server
• Description: Sets fetch size threshold border values if the selected strategy to set the fetch size is FetchSizeThresholdStrategy.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 150,300,600,1000
• Since: 6.8.4.1

heartbeat

• Module: cmas-core-server
• Description: Timestamp that indicates if an instance of the application is connected to the database schema.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 1234567899
• Since: 6.10.5.3

internal.line.access.prefix

• Module: cmas-core-server
• Description: Prefix that the company’s telephony system requires for outside lines. Set for each customer group separately.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 199
• Since: 6.9.3.0

jmx.full.exposure

• Module: cmas-core-server
• Description: Controls the availability of methods which can be used to retrieve or delete data from ConSol CM via JMX. The property is set to false by default, meaning that these methods cannot be used via JMX. If you set the property to true, these methods can be used via JMX to retrieve or delete data.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: false (default value)
• Since: 6.11.2.5

It is strictly recommended to have this property set to false on production systems.

last.config.change

• Module: cmas-core-server
• Description: Random UUID created during the last configuration change. This is a value maintained internally, please do not change it unless advised by ConSol.
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: 2573c7b7-2bf5-47ff-b5a2-bad31951a266
• Since: 6.1.0, 6.2.1

last.config.change.templates

• Module: cmas-core-server
• Description: Random UUID created during the last change in templates. This is a value maintained internally, please do not change it unless advised by ConSol.
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: 2573c7c7-2af5-4eff-b9c2-bad31951a266
• Since: 6.10.5.0

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.
• 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: 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.
• 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: 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

local.country.prefix

• Module: cmas-core-server
• Description: Prefix of the local country code. Set for each customer group separately.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 48
• Since: 6.9.3.0

mail.encryption

• Module: cmas-core-server
• Description: If the property is set to true, the encrypt checkbox in the Ticket Email Editor 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

mail.notification.engineerChange

• Module: cmas-core-server
• Description: Determines whether notification emails should be sent when the engineer of a ticket is changed.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true
• Since: 6.1.0

mail.notification.sender

• Module: cmas-core-server
• Description: From address for notification emails when the engineer of a ticket is changed. If not set, cmas-core-security, admin.email is used instead.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: cm6notification@cm6installation
• Since: 6.6.3

mail.redelivery.retry.count

• Module: cmas-core-server
• Description: Number of redelivery attempts of an outgoing email.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 3
• Since: 6.1.0

mail.smtp.email

• Module: cmas-core-server
• Description: SMTP email 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.email.password

• Module: cmas-core-server
• Description: SMTP password for outgoing email communication. If this property is set, it takes precedence over the value from the SMTP URL.
• Type: password
• Restart required: no
• System: yes
• Optional: yes
• Example value: password
• Since: 6.11.2.2

mail.smtp.email.user

• Module: cmas-core-server
• Description: SMTP user name for outgoing email communication. If this property is set, it takes precedence over the value from the SMTP URL.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: myuser
• Since: 6.11.2.2

mail.smtp.envelopesender

• Module: cmas-core-server
• Description: Email address used as 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.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

mailSender.executionInterval.seconds

• Module: cmas-core-server
• Description: Determines the period in seconds before the system checks if there are new emails to be sent.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 10
• Since: 6.12.0.0

mailSender.lockingLimit

• Module: cmas-core-server
• Description: Determines the number of emails fetched from the database for sending in a single transaction.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 1
• Since: 6.12.0.0

mailSender.lockTimeout.seconds

• Module: cmas-core-server
• Description: Determines the period in seconds before a locked email is released for another lock.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 199
• Since: 6.12.0.0

mailSender.maxAttempts

• Module: cmas-core-server
• Description: Determines the maximum number of attempts, including the first attempt, before an email is removed.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 3
• Since: 6.12.0.0

mailSender.nodeId

• Module: cmas-core-server
• Description: Determines the ID of the node on which the thread for sending emails is started (only in clustered environments). If the value is all or no value is provided, the threads are started on every node.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: all
• Since: 6.12.0.0

mailSender.retryInterval.seconds

• Module: cmas-core-server
• Description: Determines the period in seconds before another attempt to send an email is made, if the previous attempt failed.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 60
• Since: 6.12.0.0

mailSender.threads.number

• Module: cmas-core-server
• Description: Determines the number of threads for sending emails.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 1
• Since: 6.12.0.0

mailSender.txTimeout.seconds

• Module: cmas-core-server
• Description: Determines the transaction timeout for sending emails in seconds.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 60
• Since: 6.12.0.0

max.licences.perUser

• Module: cmas-core-server
• Description: Sets the maximum number of licenses which a single user can use (e.g., logging in from different browsers). By default this value is not restricted.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 10
• Since: 6.8.4.5

ml.evict.unused.after.hours

• Module: cmas-core-server
• Description: The number of hours after which a machine learning model is evicted from cache if it is not used. The ConSol CM server checks every hour for machine learning models to evict.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 24 (default value)
• Since: 6.13.0.0

ml.learn.worker.threads

• Module: cmas-core-server
• Description: The number of threads that a machine learning algorithm can use while training its machine learning model.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 1 (default value)
• Since: 6.13.0.0

monitoring.engineer.login

• Module: cmas-core-server
• Description: Login of monitoring engineer.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: nagios
• Since: 6.9.3.0

monitoring.unit.login

• Module: cmas-core-server
• Description: Login of monitoring unit.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: nagios
• Since: 6.9.3.0

nimh.enabled

• Module: cmas-core-server
• Description: Enables the 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

number.of.tasks

• Module: cmas-core-server
• Description: Number of threads to use by the Task Execution Framework (TEF).
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 1
• Since: 6.9.4.0

recent.items.cleanup.cluster.node.id

• Module: cmas-core-server
• Description: Value of a -Dcmas.clusternode.id designating the node which will clean up recent items.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 1 (assuming the cluster node started with -Dcmas.clusternode.id=1 parameter)
• Since: 6.11.0.1

recent.items.cleanup.interval.minutes

• Module: cmas-core-server
• Description: Controls the time interval (in minutes) in which recent items should be checked for removal.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 60
• Since: 6.11.0.1

recent.items.max.per.engineer

• Module: cmas-core-server
• Description: Maximum number of preserved recent items per engineer while cleaning up (older recent items will be deleted).
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 500
• Since: 6.11.0.1

recent.items.persistence.enabled

• Module: cmas-core-server
• Description: Enables persistence of recent items. If the property is set to false, it prevents storing new recent items. If a recently visited widget (recentlyVisitedWidget) is used on a dashboard, this property needs to be set to true. Otherwise, you can set it to false to save system resources.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true
• Since: 6.11.1.0

resource.replace.batchSize

• Module: cmas-core-server
• Description: Defines the number of objects to be processed in a resource replace action.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 5
• Since: 6.10.0.0

resource.replace.timeout

• Module: cmas-core-server
• Description: Transaction timeout (in seconds) of a resource replacement action step.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 120
• Since: 6.10.0.0

script.evict.unused.after.hours

• Module: cmas-core-server
• Description: Determines the number of hours for which unused scripts remain in the cache. After this time, the compiled class of the script is removed. The ConSol CM server checks for scripts to evict every hour.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 24 (default)
• Since: 6.11.1.14

script.logging.threshold.seconds

• Module: cmas-core-server
• Description: When this time, in seconds, is exceeded during script execution, a warning is emitted in the logs.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 10 (default)
• Since: 6.10.1.0

serial.mods.tracking.enabled

• Module: cmas-core-server
• Description: Low level technical flag deciding whether serial diff tracking for entities is enabled. If enabled, there will be no StackOverflow error in case a dependency between two entities (for example engineer and ticket) causes an infinite loop first and then as a result, the StackOverflow. The property must be added to the configuration manually. It will not be added to a system configuration during setup or update.

  Please enable the restricted ticket change behavior described in this section only when advised by a ConSol representative! It is a low level technical flag with intricate consequences for system behavior and thus should not be used without thorough scrutiny.

• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.10.7.0, 6.11.0.5

server.instance.task.crash.period.seconds

• Module: cmas-core-server
• Description: Determines the period (in seconds) for detecting live and crashed ConSol CM server instances.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 15 (default value)
• Since: 6.11.1.6

server.instance.task.period.seconds

• Module: cmas-core-server
• Description: Determines the interval (in seconds) between repeated task executions. The task will be executed repeatedly with the given number of seconds between each execution.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 5 (default value)
• Since: 6.11.1.6

server.session.archive.reaper.interval

• Module: cmas-core-server
• Description: Determines the interval (in seconds) when the reaper for archived server sessions is executed, refers to the database table cmas_user_session.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 60
• Since: 6.7.1

server.session.archive.timeout

• Module: cmas-core-server
• Description: Server sessions archive validity timeout (in days). After this time session info is removed from the database (refers to the database table cmas_user_session).
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 3 or 7
• Since: 6.7.1

server.session.heartbeat.enabled.WEB_CLIENT

• Module: cmas-core-server
• Description: Determines if the session heartbeat is enabled for the Web Client. If this property is enabled, a heartbeat is sent to the ConSol CM server every 60 seconds and with every page reload. If the server does not receive a heartbeat during the configured interval (see server.session.heartbeat.timeout.seconds), the session is considered orphaned and ended according to the configured mode (see server.session.heartbeat.mode).
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true (default value)
• Since: 6.11.2.9

server.session.heartbeat.mode

• Module: cmas-core-server
• Description: Determines when orphaned sessions are ended if the session heartbeat is enabled (see server.session.heartbeat.enabled.WEB_CLIENT). There are two possible values:
  • LAZY: Orphaned sessions are ended when the same user authenticates again or when there are no more licenses available (default value).
  • EAGER: Orphaned sessions are ended immediately.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: LAZY (default value)
• Since: 6.11.2.9

server.session.heartbeat.timeout.seconds

• Module: cmas-core-server
• Description: Determines the period after which a session is considered orphaned if the session heartbeat is enabled (see server.session.heartbeat.enabled.WEB_CLIENT) and no heartbeat is received. The default value is 300, meaning that orphaned sessions are ended after 5 minutes.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 300 (default value)
• Since: 6.11.2.9

server.session.reaper.interval

• Module: cmas-core-server
• Description: Determines the interval (in seconds) when the reaper for inactive (ended) server sessions is executed, refers to the database table cmas_user_session.
• Type: integer
• Restart required: only Session Service
• System: yes
• Optional: no
• Example value: 10800 (3 hours)
• Since: 6.6.1, 6.7.1

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

skip.wfl.transfer.cleanup

• Module: cmas-core-server
• Description: If set to true, skips workflow cleanup after transfer.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.9.4.1

skip.wfl.transfer.translations.cleanup

• Module: cmas-core-server
• Description: Enables skipping the cleanup of localized properties of removed workflow elements.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.10.5.5

strict.utf.bmp.enabled

• Module: cmas-core-server
• Description: ConSol CM installations which use a MySQL database with a 2-byte encoding / collation setting cannot handle incoming emails which contain 4-byte UTF8 characters.
  If you set this property to true, all 4-byte UTF8 characters are filtered out from email subjects before any database interaction. Since 6.11.2.7, it also filters out 4-byte UTF8 characters from other header fields, and since 6.11.2.8 UTF8 characters are filtered out from the names of email attachments.
  By default, the property value is true for MySQL databases, and false for any other database where the underlying problem should not occur. Do not change it for a MySQL database, unless you are sure that the database supports 4-byte characters.

• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: false
• Since: 6.10.6.0, changed in 6.11.2.7 and 6.11.2.8

task.execution.interval.seconds

• Module: cmas-core-server
• Description: Time in seconds between the end of an accomplished task in the TEF (Task Execution Framework) and the start of the next task.
• Type: Integer
• Restart required: no
• System: no
• Optional: no
• Example value: 5
• Since: 6.9.4.0

task.execution.node.id

• Module: cmas-core-server
• Description: Only relevant in clustered environments. The ID of the node where scripts of the TEF (Task Execution Framework) will be executed. This applies to both scripts called from the workflow and scripts called manually using the Admin Tool. The Admin Tool can be started from any node.
• Type: Integer
• Restart required: yes
• System: no
• Optional: yes
• Example value: 2
• Since: 6.11.0.1

tickets.delete.size

• Module: cmas-core-server
• Description: Defines the number of tickets deleted per transaction.
• Type: integer
• Restart required: only Session Service
• System: yes
• Optional: no
• Example value: 10 (default value)
• Since: 6.8.1

ticket.delete.timeout

• Module: cmas-core-server
• Description: Transaction timeout (in seconds) for deleting tickets.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 60
• Since: 6.1.3

ticket.from.incoming.message.accepted.links

• Module: cmas-core-server
• Description: List of domains to which links in incoming emails and links in comments added via REST API are clickable in the ticket history. Regular expressions can be used to specify the allowed URLs. It is possible to add several URLs by using a whitespace as delimiter. The URL must start with one of the allowed protocols (http, https, ftp, ftps, file, mailto). All other links are removed, i.e., the link is displayed in the ticket history as text but it cannot be clicked. If the property is left empty, all links are removed. The regular expression .+ can be used to allow all domains.
• Type: string
• Restart required: no
• System: no
• Optional: no
• Example value: https://.*\.consol\.de (allows links to https://<any>.consol.de)
• Since: 6.11.1.7

Please note that whitelisting domains might make ConSol CM vulnerable to cross-site scripting and other attacks. Choose the domains you whitelist carefully!

transaction.timeout.minutes

• Module: cmas-core-server
• Description: Sets the transaction timeout for the task execution service, i.e., one run of a task must finish before this timeout is reached. The changes are visible only for new tasks, the execution of which started after the configuration change.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 10*60 (10 hours - default value)
• Since: 6.10

unit.description.mode

• Module: cmas-core-server
• Description: Defines whether unit (contact) descriptions in the ticket history are taken from the database or dynamically rendered using templates. The value, DYNAMIC, is a bit more costly from the performance perspective, while PROTOCOL is faster but returns historical names which might be outdated. Use PROTOCOL if you have lots of history entries from many different units. This is also the default value in CM versions 6.11.1.1 and up. In CM versions up to 6.11.1.0, DYNAMIC is the default.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: PROTOCOL
• Since: 6.11.0

unit.replace.batchSize

• Module: cmas-core-server
• Description: Defines the number of objects to be processed in a unit replace action.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 5
• Since: 6.8.2

unit.replace.timeout

• Module: cmas-core-server
• Description: Transaction timeout (in seconds) of a unit replacement action step.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 120
• Since: 6.8.2

unused.content.remover.cluster.node.id

• Module: cmas-core-server
• Description: Value of a cmas.clusternode.id designating which node will remove unused ticket attachments and unit content entries.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 1 (assuming cluster node started with the parameter -Dcmas.clusternode.id=1)
• Since: 6.9.0.0

unused.content.remover.enabled

• Module: cmas-core-server
• Description: Specifies whether a removal of unused ticket attachments and unit content entries should take place.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true
• Since: 6.9.0.0

unused.content.remover.polling.minutes

• Module: cmas-core-server
• Description: Determines how often unused ticket attachments and unit content entries should be checked for removal.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 15
• Since: 6.9.0.0

unused.content.remover.ttl.minutes

• Module: cmas-core-server
• Description: Minimum interval, in minutes, after which unused ticket attachments and unit content entries can be removed.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 1440
• Since: 6.9.0.0

url.track

• Module: cmas-core-server
• Description: Determines the URL of CM/Track to be used by the class LinkService to generate links to tickets in CM/Track. The following example shows how the use the convenience method to generate a link to a ticket (the ticket object is passed as a parameter).

  url = linkTo.track(ticket);

• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: http://localhost:8080/track
• Since: 6.13.0.0

url.webclient

• Module: cmas-core-server
• Description: Determines the URL of the Web Client to be used by the class LinkService to generate links to tickets, customers or resources in the Web Client. The following example shows how the use the convenience method to generate a link to a customer (the customer object is passed as a parameter).

  url = linkTo.webclient(unit);

• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: http://localhost:8080/cm-client
• Since: 6.13.0.0

warmup.executor.enabled

• Module: cmas-core-server
• Description: Specifies whether the server should asynchronously warm up during startup (e.g., fill some of the internal caches).
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true
• Since: 6.9.4.2

wfl.sticky.transfer.disabled

• Module: cmas-core-server
• Description: Enables using preserved original names of workflow elements.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false
• Since: 6.10.1.0

workflow.deploy.cache.eviction.disabled

• Module: cmas-core-server
• Description: Determines if the infinispan cache should be cleared after deployment (true) or not (false). If the property is set to true, all mappings are removed from the cache.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.11.1.4

cmas-core-shared (module)

cluster.mode

• Module: cmas-core-shared
• Description: Specifies whether ConSol CM is running in a cluster.
• Type: boolean
• Restart required: yes
• System: yes
• Optional: no
• Example value: false
• Since: 6.1.0

cluster.unicast

• Module: cmas-core-shared
• Description: Flag to activate jgroups unicast mode for ConSol CM clusters (as opposed to the default multicast mode causing problems in some data center environments). If set to true, remember to set the JVM start parameters: jgroups.bind.port, jgroups.bind.address and jgroups.initial_hosts.
• Type: boolean
• Restart required: yes
• System: yes
• Optional: yes
• Example value: false (default value)
• Since: 6.11.0.0
• Removed in: 6.12.0.0

data.directory

• Module: cmas-core-shared
• Description: Directory for ConSol CM data (e.g., index)
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: C:\Users\user\cmas
• Since: 6.0

expert.mode

• Module: cmas-core-shared
• Description: Switches expert mode on/off thereby unblocking/blocking expert features. For example, the CM system property initialized is only available in the expert mode.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: false
• Since: 6.0

cmas-dwh-server (module)

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 in a 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: 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 the set 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

last.ping.timestamp

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property shows the status of CMRF and is filled automatically by the CMRF. It contains the date of the last response on the ping from the ConSol CM server to the CMRF.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 32323214
• Since: 6.11.0.1

live.start

• Module: cmas-dwh-server
• Description: When the DWH synchronization mode is set to LIVE using the Admin Tool (navigation group Data Warehouse, navigation item Administration, Configuration button), this property is created and set to the current date.
  If LIVE mode is not enabled and there is no data in cmas_dwh_ser_sync_object, the property live.start is deleted.
• Type: integer
• Restart required: no
• System: no
• Optional: yes (automatically added in DWH LIVE mode)
• Example value: 15028802377645
• Since: 6.7.0

notification.error.description

• Module: cmas-dwh-server
• Description: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: pop3

notification.tls.enabled

• Module: cmas-dwh-server
• Description: Activates 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 activated 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

statistics.calendar

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.client.group

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.contact.role

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.content.entry

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.content.entry.class

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.content.entry.history

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.customer.definition

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.engineer

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.enum.group

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.field.definition

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.group.definition

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.locale

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.localized.property

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.mla

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.project

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.queue

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.resource

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.resource.group

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.resource.history

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.resource.relation.definition

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.resource.type

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.ticket

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.ticket.function

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.ticket.history

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.time.booking

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.timestamp

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.unit

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.unit.history

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.unit.relation.definition

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

statistics.workflow

• Module: cmas-dwh-server
• Description: Internal DWH property, not to be changed manually. This property is filled automatically by the CMRF to store statistical data from the DWH. This data is displayed in the Admin Tool, section Data Warehouse -> Monitor -> CMRF Statistics.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: 0
• Since: 6.11.0.1

time.buffer

• Module: cmas-dwh-server
• Description: Number of minutes to extend date of start live mode.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 5
• Since: 6.8.1.11

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

cmas-nimh (module)

filesystem.polling.threads.number

• Module: cmas-nimh
• Description: Number of threads started for database emails' queue polling. 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: With this property the service thread related to a given poller can be disabled.
• 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 for polling mailboxes in seconds.
• 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 will be 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. 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 (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.<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.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 emails.
• 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 emails.
• 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 for a given mailbox from which the poller reads emails.
• 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 emails.
• 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 for further information. 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 for further information. 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 Backups section of the Admin Tool.
• 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 for further information. 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 for further information. Determines the size of partial fetch in bytes for the indicated protocol.
  For IMAP systems: in CM versions 6.10.7.0 and up, the value of mailbox.default.session.mail.imap.fetchsize is set to 1048576 (equals 1 MB) during the initial setup of a ConSol CM system. During an update of an existing ConSol CM system, the value of the property is left unchanged, if the property is already present. In case the property is not yet present, it is added with the default value.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 1048576
• 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 for further information. Determines whether the protocol’s partial fetch capability should be used.
  For IMAP systems: in CM versions 6.10.7.0 and up, the value of mailbox.default.session.mail.imap.partialfetch is set to false during the initial setup of a ConSol CM system. During an update of an existing ConSol CM system, the value of the property is left unchanged, if the property is already present. In case the property is not yet present, it is added with the default value.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true
• 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 for further information. 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: This defines whether messages should be removed from the mailbox after processing. For 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 for polling mailboxes in seconds.
• 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 (see section Email Backups). 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 mailbox. Must be correlated with 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 environment (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. 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: Main emails' queue polling thread interval.
• 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 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 (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 for email processing in the pipe.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 60 (default value)
• Since: 6.4.0

cmas-nimh-extension (module)

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 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: From address for error emails from NIMH
• 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: To address for error emails from NIMH. As a default the email address of the administrator which you have entered during system setup 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 email is sent to the above configured address in case the email message 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

cmas-restapi-core (module)

comment.authors.disabled

• Module: cmas-restapi-core
• Description: Disables the display of the content's author via REST API.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.11.0

csrf.domain.allow.none

• Module: cmas-restapi-core
• Description: Determines whether empty Origin/Referer headers are accepted. By default, the property is set to false, so that existing REST requests without Origin/Referer headers work.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: false (default value)
• Since: 6.11.2.2

csrf.domain.white.list

• Module: cmas-restapi-core
• Description: The list of domains (separated with “|”) which are allowed in Origin/Referer headers and will not be blocked by the CSRF (cross-site request forgery) filter. By default, the property is empty so that cross-site requests are blocked.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: https://example.com:80 | http://www.consol.de:8080
• Since: 6.11.2.2

csrf.request.filter.enabled

• Module: cmas-restapi-core
• Description: It allows to disable the CSRF (cross-site request forgery) request filter for the REST API.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true (default value)
• Since: 6.11.2.2

diff.tracking.disabled

• Module: cmas-restapi-core
• Description: Fallback property for disabling diff tracking for CM/Track, which is history-based so it can be heavy.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.10.5.6

domain.map.for.client.config.<DOMAIN_NAME>

• Module: cmas-restapi-core
• Description: Enables mapping multiple instances of CM/Track to a specific domain. DOMAIN_NAME is the name of the client configuration in the Admin Tool (if your CM/Track configuration is called trackV2customized, the name of the property is domain.map.for.client.config.trackV2customized). You can provide several URLs separated by a comma.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: https://www.consol.de, https://www.consol.com
• Since: 6.10.7.0

request.log.threshold.milliseconds

• Module: cmas-restapi-core
• Description: Time threshold in milliseconds that needs to be exceeded to generate an entry in the file operationtimes-rest.log.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 5000 (default value)
• Since: 6.13.0.2

request.log.username

• Module: cmas-restapi-core
• Description: Name of the user whose requests are logged in the file operationtimes-rest.log. Only one name is supported. If the property is empty (default value), the requests of all users are logged.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: admin
• Since: 6.13.0.2

security.fields.customer.exposure.check.enabled

• Module: cmas-restapi-core
• Description: Enables customer exposure annotation checks for ticket fields.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true (default value)
• Since: 6.10.5.4

security.restrict.unit.access.to.own.data

• Module: cmas-restapi-core
• Description: If set to true, an additional check is performed when a user logs in as a customer using the REST API, e.g. CM/Track. When requesting customer data, only the company of the user or other contacts of the user’s company are returned. If set to false, no additional security check is performed and the former security rules apply.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true (default value)
• Since: 6.9.2.14

cmas-restapi-http-headers (module)

This module contains properties which represent header fields which should be sent with REST API requests and responses.

Each property in the module cmas-restapi-http-headers represents one header field. The property name/key identifies the HTTP 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 HTTP client.

For example, if you add the property Access-Control-Allow-Origin with the value http://www.example.com to the cmas-restapi-http-headers module, REST API requests from http://www.example.com can be allowed in your domain even if the general policy is to allow only requests from the same domain.

As there are no default values for the headers in this module, the module is not displayed when creating the first property in it. The module name needs to be typed in manually in this case.

cmas-setup-hibernate (module)

cmas.dropSchemaBeforeSetup

• Module: cmas-setup-hibernate
• Description: Flag if schema is to be (was) dropped during setup
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: true
• Since: 6.0

connection.release.mode

• Module: cmas-setup-hibernate
• Description: Describes the JEE connection handling strategy for transactions. If set to AFTER_TRANSACTION, the connection will be cached during the transaction and released at the end. If set to AFTER_STATEMENT, the connection will be released to the pool after each statement execution. Please do not change the default here unless advised by ConSol.
• Type: string
• Restart required: yes
• System: no
• Optional: yes
• Example value: AFTER_STATEMENT (default for JEE environment)
• Since: 6.0

hibernate.dialect

• Module: cmas-setup-hibernate
• Description: The dialect used by hibernate. Usually set during initial set-up (depending on the database system).
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: org.hibernate.dialect.MySQL5InnoDBDialect
• Since: 6.0

update.6.11.0.0.sleep

• Module: cmas-setup-hibernate
• Description: Helper property for the update preparation scripts introduced in context of CM database refactoring in version 6.11. This is an optional setting allowing a delay (in milliseconds) after each loop iteration of the preparation scripts. Setting the delay should lower the database load, for example during working hours. This property may be removed after the update preparation tasks finish.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 0
• Since: 6.11.0.0, for use in 6.10.5.x

update.6.11.0.0.timezone

• Module: cmas-setup-hibernate
• Description: Helper property for the ticket history migration (the new way of counting history groups). Since 6.11.0.0 the groups are constant (2h time span), but before 6.11.0.0 groups were not constant and depended on the customer’s time zone. Migration scripts use an old algorithm to calculate groups and therefore need information about the time zone. The property should be set to the timezone which is most commonly used by the customers. If the property is not set, the default server time zone is used (TimeZone.getDefault()). The property should be set before updating to 6.11.0.0 and will be removed automatically after migration. The list of accepted timezones can be found for example here: http://joda-time.sourceforge.net/timezones.html.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: Europe/Berlin
• Since: 6.11.0.0, for use before updating to this version

cmas-setup-manager (module)

initialized

• Module: cmas-setup-manager
• Description: Flag if ConSol CM is initialized. If this value is missing or not true, the setup will be performed. Starting with ConSol CM version 6.11, this property is only available in expert mode.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true
• Since: 6.0

Be careful with using this property! When you set the value to false, the ConSol CM server will perform the system setup at the next start, i.e. all data of the existing system is lost, including system properties!

cmas-setup-scene (module)

scene

• Module: cmas-setup-scene
• Description: Scene file which was imported during setup (can be empty).
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: vfszip:/P:/dist/target/jboss/server/cmas/deploy/cm-dist-6.5.1-SNAPSHOT.ear/APP-INF/lib/dist-scene-6.5.1-SNAPSHOT.jar/META-INF/cmas/scenes/helpdesk-sales_scene.jar/
• Since: 6.0

cmas-web-notifications (module)

notifications.enabled

• Module: cmas-web-notifications

• Description: Determines whether the notifications feature is enabled (true) or disabled (false). The default value is true for ConSol CM systems running on JBoss application servers, and false for ConSol CM systems running on WebLogic application servers.

  If you use the notifications feature on a ConSol CM system behind a proxy, some special proxy settings are needed. Please see section Operating ConSol CM Behind a Proxy (e.g., Apache HTTPD) of the ConSol CM Setup Manual for further information.

• Type: boolean
• Restart required: no
• System: no
• Optional: no
• Example value: true
• Since: 6.12.0.0

ttl.days

• Module: cmas-web-notifications
• Description: Determines the time (in days) after which unpinned notifications are removed.
• Type: integer
• Restart required: no
• System: no
• Optional: no
• Example value: 15
• Since: 6.12.0.0

cmas-workflow-engine (module)

jobExecutor.adminMail

• Module: cmas-workflow-engine
• Description: Email address which will get notified about job execution problems (when retry counter is exceeded).
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: admin@consol.de
• Since: 6.8.0

jobExecutor.idleInterval.seconds

• Module: cmas-workflow-engine
• Description: Determines how often the job executor thread will look for new jobs to execute.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 45 (default value up to CM version 6.10.5.2. The default value for CM versions 6.10.5.3 and up is 5)
• Since: 6.8.0

jobExecutor.jobMaxRetries

• Module: cmas-workflow-engine
• Description: Controls the number of retry attempts the job executor will do before declaring a job as failed.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 5 (default value)
• Since: 6.8.0

jobExecutor.jobMaxRetriesReachedSubject

• Module: cmas-workflow-engine
• Description: The subject used in the notification mail which administrators receive about failed job executors.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: Job maximum retries reached. Job was removed!!! (default value)
• Since: 6.8.0

jobExecutor.lockingLimit

• Module: cmas-workflow-engine
• Description: Number of jobs locked at once (marked for execution) by the job executor thread.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 5 (default value since CM version 6.10.5.3)
• Since: 6.8.0

jobExecutor.lockTimeout.seconds

• Module: cmas-workflow-engine
• Description: Determines how long the job can be locked (marked for execution) by the job executor.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 360 (default value)
• Since: 6.8.0

jobExecutor.mailFrom

• Module: cmas-workflow-engine
• Description: Email address which will be set as From header for notifications to the administrator.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: jobexecutor@consol.de
• Since: 6.8.0

jobExecutor.maxInactivityInterval.minutes

• Module: cmas-workflow-engine
• Description: Number of minutes of allowed job executor inactivity (e.g. when it is blocked by long timer execution). After this time executors threads are restarted.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 30 (default value)
• Since: 6.9.2.0

jobExecutor.threads

• Module: cmas-workflow-engine
• Description: Number of job execution threads.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 1 (default value)
• Since: 6.8.0

jobExecutor.timerRetryInterval.seconds

• Module: cmas-workflow-engine
• Description: Determines how long the job executor thread will wait after job execution error.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 10 (default up to CM version 6.10.5.2. The default value for CM versions 6.10.5.3 and up is 30)
• Since: 6.8.0

jobExecutor.txTimeout.seconds

• Module: cmas-workflow-engine
• Description: Transaction timeout used for job execution.
• Type: integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 60 (default value)
• Since: 6.8.0

cmas-workflow-jbpm (module)

fetchLock.interval

• Module: cmas-workflow-jbpm
• Description:
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 5000
• Removed in: 6.8.0

jobExecutor.idleInterval

• Module: cmas-workflow-jbpm
• Description:
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 45000
• Removed in: 6.8.0
• Replaced by: jobExecutor.idleInterval.seconds

jobExecutor.jobExecuteRetryNumber

• Module: cmas-workflow-jbpm
• Description:
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 5
• Removed in: 6.8.0
• Replaced by: jobExecutor.jobMaxRetries

jobExecutor.timerRetryInterval

• Module: cmas-workflow-jbpm
• Description:
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 10000
• Removed in: 6.8.0
• Replaced by: jobExecutor.timerRetryInterval.seconds

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

outdated.lock.age

• Module: cmas-workflow-jbpm
• Description:
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 60000
• Removed in: 6.8.0
• Replaced by: cmas-workflow-engine, jobExecutor.lockTimeout.seconds

refreshTimeInCaseOfConcurrentRememberMeRequests

• Module: cmas-workflow-jbpm
• Description: It sets the refresh time (in seconds) after which the page will be reloaded in case of concurrent remember me requests. This feature prevents one user from occupying many licenses. Please increase that time if sessions are still occupying.
• Type: integer
• Restart required: yes
• System: yes
• Optional: yes
• Example value: 5
• Since: 6.8.2

cmweb-server-http-headers (module)

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

cmweb-server-adapter (module)

attachment.upload.timeout

• Module: cmweb-server-adapter
• Description: Defines the transaction timeout in minutes for adding attachments to a ticket, resource or customer. Counts the time for the upload of all attachments of one transaction. When the timeout occurs, all files which have been temporarily stored on the server are deleted. No file is uploaded.
• Type: Integer
• Restart required: no
• System: yes
• Optional: yes
• Example value: 3
• Since: 6.10.5.3

automatic.booking.enabled

• Module: cmweb-server-adapter
• Description: If enabled, time spend on creating comment/email will be measured and automatic time booking will be added.
• Type: boolean
• Restart required: no
• System: yes
• Optional: yes
• Example value: true
• Since: 6.9.4.2

checkUserOnlineIntervalInSeconds

• Module: cmweb-server-adapter
• Description: The interval in seconds to check which users are online (default 180sec = 3min).
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 180
• Since: 6.0
• Removed in: 6.5 / 6.11.0.1

cmoffice.enabled

• Module: cmweb-server-adapter
• Description: Flag if CM/Doc (former CM/Office) is enabled.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: false
• Since: 6.4.0

cmoffice.oo.path.NUMBER

• Module: cmweb-server-adapter
• Description: Possible location of the OpenOffice installation. The properties are numbered starting with 0.
• Type: string
• Restart required: no
• System: no
• Optional: yes
• Example value: c:\Program Files (x86)\LibreOffice 3.6\program
• Since: 6.10.1.0
• Removed in: 6.12.0.0

cmoffice.strict.versioning.enabled

• Module: cmweb-server-adapter
• Description: Controls if the SAVE operation in Microsoft Word / OpenOffice documents creates a new attachment (true) or overwrites the existing attachment (false). This concerns the behavior within one session using the text editing program. If the program is stopped, the overwrite mechanism will not work anymore.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true
• Since: 6.10.5.4

cmoffice.websocket.port

• Module: cmweb-server-adapter
• Description: Determines the port on which the CM/Doc application should be started and connected to.
• Type: integer
• Restart required: no
• System: no
• Optional: yes
• Example value: 30333
• Since: 6.12.0.0

commentRequiredForTicketCreation

• Module: cmweb-server-adapter
• Description: Flag if the comment is a required field for ticket creation.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true (default value)
• Since: 6.2.0

csrf.domain.white.list

• Module: cmweb-server-adapter
• Description: The list of domains (separated with “|”) which are allowed and will not be checked by CSRF (cross-site request forgery) filter
• Type: String
• Restart required: no
• System: no
• Optional: yes
• Example value: example.com | consol.de
• Since: 6.10.7.0

csrf.request.filter.enabled

• Module: cmweb-server-adapter
• Description: It allows to disable CSRF (Cross-site request forgery) request filter
• Type: Boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true
• Since: 6.10.7.0

customizationVersion

• Module: cmweb-server-adapter
• Description: UID representing the latest web customization version. Used only internally, please do not change the value.
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: cd58453e-f3cc-4538-8030-d15e8796a4a7
• Since: 6.5.0

data.optimization

• Module: cmweb-server-adapter
• Description: Defines optimization to be applied on response data. So far, the following values are supported (for setting more than one value, separate values by '|'): MINIFICATION and COMPRESSION. MINIFICATION minifies HTML data by e.g. stripping whitespaces and comments. COMPRESSION applies gzip compression to HTTP response. (Note: If you are running in cluster mode and want to test different configurations in parallel, you can set different values for each cluster node by specifying property data.optimization.nodeId to override default property.)
• Type: string
• Restart required: COMPRESSION can be switched on/off without restart, MINIFICATION requires restart.
• System: yes
• Optional: yes
• Example value: MINIFICATION|COMPRESSION

defaultAttachmentEntryClassName

• Module: cmweb-server-adapter
• Description: The default content entry class used to classify an attachment if no other class was set explicitly.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: DefaultTextElement
• Since: 6.9.2.0

defaultContentEntryClassName

• Module: cmweb-server-adapter
• Description: Default text class for new ACIMs.
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: default_class
• Since: 6.3.0

defaultNumberOfCustomFieldsColumns

• Module: cmweb-server-adapter
• Description: Default number of columns for ticket fields.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 3
• Since: 6.2.0

diffTrackingEnabled

• Module: cmweb-server-adapter
• Description: Removed in ConSol CM version 6.11.
  Defines if parallel editing of a ticket by different engineers should be possible.
  false: Previous way of handling changes when editing a ticket. If the ticket has been changed in the meantime, the current engineer will not be able to submit his changes without being forced to reload the page before submitting.
  true: New changes handling mode. If the ticket has been changed, this will not block the submission of other changes anymore. If the part of the ticket that was changed was exactly the part that is changed by the submitting engineer, then an information message will be displayed, but the ticket change will be persisted/stored anyway.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: true (default)
• Since: 6.10.1
• Removed in: 6.11.0

diffTrackingEnabledForUnitAndResource

• Module: cmweb-server-adapter
• Description: Enables the prevention of concurrent modifications on units / resources.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: 3
• Since: 6.11.0.0

favoritesSizeLimit

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

forward.mails.to.representatives

• Module: cmweb-server-adapter
• Description: Determines if emails which are manually sent from the Web Client are also sent to representing engineers. The default value of the property is false, meaning that this kind of emails are not forwarded to the representing engineer. Set the property to true if you want to restore the previous behavior, i.e., all emails which are sent to the represented engineer are automatically forwarded to the representing engineer. Please take into account that this might not be desired if the same person is an engineer and a customer in the CM system.
• Type: boolean
• Restart required: no
• System: no
• Optional: no
• Example value: false (default value)
• Since: 6.11.1.7

This property only configures the handling of manually sent emails. The handling of automatically sent emails depends on the used Java method.

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

helpFilePath

• Module: cmweb-server-adapter
• Description: URL for online help. If not empty, the Help link is displayed in the Web Client.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: http://www.consol.de
• Since: 6.2.1

hideTicketSubject

• Module: cmweb-server-adapter
• Description: If set to true, the ticket subject is hidden.
• Type: boolean
• Restart required: no
• System: yes
• Optional: no
• Example value: false
• Since: 6.2.1

mail.from

• Module: cmweb-server-adapter
• Description: This email address is used instead of the engineer’s email address during email conversations.
• 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: When set, the Ticket Email Editor in the Web Client displays a Reply-To field prefilled with this value.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: consolcm@example.com
• Since: 6.0.1

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

mailTemplateAboveQuotedText

• Module: cmweb-server-adapter
• Description: Determines the behavior of the email template in the Ticket 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

maxSizePerPagemapInMegaBytes

• Module: cmweb-server-adapter
• Description: The parameter defines the size (in MB) of the file which is created by the Wicket framework per user session. i.e. for each engineer which is currently logged in. The file is used to save pages during the running session. When the defined size limit has been reached and new entries are added, the oldest entries are removed. In the Web Client, due to this behavior, an engineer who works with an "old" page will be redirected to the Overview/Start page (usually the dashboard page) when the "old" page is removed from the file.
  So in case engineers who work with a great number of open tabs in ConSol CM and complain about being redirected to the Overview page, it might be useful to increase this parameter. In large systems, you could use e.g. a value of 45 or 50. Since this is the size of the file which is saved on disk, the maximum value depends on the available disk space, however, a value which is too large is not recommended either.
• Type: integer
• Restart required: yes
• System: yes
• Optional: no
• Example value: 15
• Since: 6.3.5

pagemapLockDurationInSeconds

• Module: cmweb-server-adapter
• Description: Number of seconds to pass before pagemap is considered to be locked for too long.
• Type: integer
• Restart required: yes
• System: yes
• Optional: yes
• Example value: 60
• Since: 6.7.3

postActivityExecutionScriptName

• Module: cmweb-server-adapter
• Description: Defines the name for the script which should be executed after every workflow activity, see section PostActivityExecutionScript. If no script should be executed, leave the value empty.
• Type: string
• Restart required: no
• System: yes
• Optional: no
• Example value: postActivityExecutionHandler
• Since: 6.2.0

queuesExcludedFromGS

• Module: cmweb-server-adapter
• Description: Comma-separated list of queue names which are excluded from Quick Search.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: Helpdesk,FAQ
• Since: 6.0

rememberMeLifetimeInMinutes

• Module: cmweb-server-adapter
• Description: Lifetime for remember me in minutes.
• Type: integer
• Restart required: yes
• System: yes
• Optional: no
• Example value: 1440
• Since: 6.0

request.scope.transaction

• Module: cmweb-server-adapter
• Description: It allows to disable request scope transaction. By default one transaction is used per request. Setting this property to false there will cause one transaction per service method invocation.
• Type: boolean
• Restart required: yes
• System: yes
• Optional: yes
• Example value: true
• Since: 6.8.1

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 the 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

serverPoolingInterval

• Module: cmweb-server-adapter
• Description: Defines the time in seconds for pooling server to invalidate caches on the web layer.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 5
• Since: 6.1.0

show.error.stacktrace

• Module: cmweb-server-adapter
• Description: If this property is set to true, the full stracktrace can be shown in the generic red error message which is displayed in the Web Client if a user action caused an exception.
• Type: boolean
• Restart required: no
• System: yes
• Optional: yes
• Example value: false (default value)
• Since: 6.12.1.0

supportEmail

• Module: cmweb-server-adapter
• Description:
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Since: 6.0
• Removed in: 6.11.0.1

themeOverlay

• Module: cmweb-server-adapter
• Description: Name of the folder containing the skin used to customize the layout of the Web Client.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: consolINT
• Since: 6.0, functionality changed in 6.11.2.0

ticketListRefreshIntervalInSeconds

• Module: cmweb-server-adapter
• Description: Refresh interval for the ticket list (in seconds).
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 180
• Since: 6.0

ticketListSizeLimit

• Module: cmweb-server-adapter
• Description: Maximum number of tickets in ticket list.
• Type: integer
• Restart required: no
• System: yes
• Optional: no
• Example value: 100
• Since: 6.0

tx.read.only.mode.enabled

• Module: cmweb-server-adapter
• Description: Enables read-only transactions for faster page loading. This transactional behavior was introduced in 6.11.0, and this property acts as a safety guard to restore the old behaviors. Do not change this value unless facing tx problems and advised by ConSol.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: true (default value)
• Since: 6.11

tinymce.enabled

• Module: cmweb-server-adapter
• Description: Determines whether Froala (false) or TinyMCE (true) is used as an editor for the Web Client.
• Type: boolean
• Restart required: no
• System: no
• Optional: yes
• Example value: false (default value)
• Since: 6.12.1.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

urlLogoutPath

• Module: cmweb-server-adapter
• Description: URL which is opened when the user logs out. There are three configuration possibilities:
  • Empty value: The user is redirected to the login page.
  • <CM URL>/cm-client/logout: The user is redirected to the logout page, which includes a link to log in again.
  • Any URL: The user is redirected to the given URL outside ConSol CM.
• Type: string
• Restart required: no
• System: yes
• Optional: yes
• Example value: https://mycmserver/cm-client/logout
• Since: 6.3.1, behavior changed in 6.11.2.0

voCacheEnabled

• Module: cmweb-server-adapter
• Description: This property enables additional caching for the Web Client, voCaching, of complete objects, thus improving performance.
• Type: boolean
• Restart required: no
• System: yes
• Optional: yes
• Example value: true
• Since: 6.11.1.0
  

webSessionTimeoutInMinutes

• Module: cmweb-server-adapter
• Description: Session timeout in minutes.
• Type: integer
• Restart required: yes
• System: yes
• Optional: no
• Example value: 180
• Removed in: 6.7.1
• Replaced by: cmas-core-server, server.session.timeout

wicketAjaxRequestHeaderFilterEnabled

• Module: cmweb-server-adapter
• Description: This enables filter for Wicket AJAX requests, coming from stale pages with Wicket 1.4 scripting (CM pre-6.8.0), after update to CM6 post-6.8.0.
• Type: boolean
• Restart required: yes
• System: yes
• Optional: yes
• Example value: false
• Since: 6.8.1