Alphabetical List of System Properties
This chapter describes the following properties:
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
admin.tool.consumed.licences.check.interval
- Module: cmas-app-admin-tool
- Description: Sets the interval (in seconds) to monitor the number of consumed licenses. The default value is 30.
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 30
- 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. The default value is CONCURRENT_USERS.
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Example value: CONCURRENT_USERS
- Since: 6.11.0.0
admin.tool.session.check.interval
- Module: cmas-app-admin-tool
- Description: Admin Tool inactive (ended) sessions check time interval (in seconds)
- Type: integer
- Restart required: yes
- System: yes
- Optional: no
- Example value: 30
- Since: 6.7.5
attachment.allowed.types
- Module: cmas-core-server
- Description: Comma-separated list of allowed filename extensions (if no value defined, all file extensions are allowed).
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: txt,zip,doc
- Since: 6.5.0
attachment.max.size
- Module: cmas-core-server
- Description: Maximum attachment size, in MB. This is a validation property of the CM API. It controls the size of attachments at tickets, at units, and at resources. It also controls the size of incoming (not outgoing!) email attachments.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 100
- Since: 6.4.0
attachment.upload.timeout
- Module: cmweb-server-adapter
- Description: Defines the transaction timeout in minutes for adding attachments to a ticket, a resource or a 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
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
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
- Since: 6.7.0
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
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
batch-commit-interval
- Module: cmas-dwh-server
- Description: Number of objects in a JMS message. Larger values mean better transfer performance at the cost of higher memory usage.
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 the batch.commit.interval.
- Default value: 1000
- Type: integer
- Restart required: no
- System: yes
- Optional: yes
- Example value: 100
- Since: 6.0.0
big.task.minimum.size
- Module: cmas-core-index-common
- Description: Indicates the minimum size of index task (in parts, each part has 100 entities) to qualify this task as a big one. Big tasks have lower priority than normal tasks.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 15 (default)
- Since: 6.8.3
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
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
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
cluster.mode
- Module: cmas-core-shared
- Description: Specifies whether CMAS is running in 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)
- Since: 6.11.0.0
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
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
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
comment.authors.disabled
- Module: cmas-restapi-core
- Description: Disables the display of the content's author via REST API. The default value is false.
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: false
- Since: 6.11.0
commentRequiredForTicketCreation
- Module: cmweb-server-adapter
- Description: Flag if comment is a required field for ticket creation.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: true (default)
- Since: 6.2.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)
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 single transaction.
- Type: Boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: true
- Since: 6.11.1.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
contact.authentication.method
- Module: cmas-core-security
- Description: Indicates contact authentication method, where possible values are DATABASE or LDAP or LDAP,DATABASE or DATABASE,LDAP.
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Since: 6.9.3.0
contact.inherit.permissions.only.to.own.customer.group
- Module: cmas-core-security
- Description: Indicates whether authenticated contact inherits all customer group permissions from the representing engineer (false) or only has permissions to his own customer group (true).
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Since: 6.9.2.3
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
dao.log.threshold.milliseconds
- Module: cmas-core-server
- Description: Used to configure database operation times logging. DAO methods whose execution take 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)
- 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.
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Example value: webadmin (default: empty string)
- Since: 6.11.1.0
data.directory
- Module: cmas-core-shared
- Description: Directory for CMAS data (e.g., index)
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: C:\Users\user\cmas
- Since: 6.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
database.notification.enabled
- Module: cmas-core-index-common
- Description: Indicates whether index update database notification channel should be used instead of JMS.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: false
- Since: 6.8.4.7
database.notification.redelivery.delay.seconds
- Module: cmas-core-index-common
- Description: In case of index update database notification channel, indicates notification redelivery delay when an exception occurs.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 60
- Since: 6.8.4.7
database.notification.redelivery.max.attempts
- Module: cmas-core-index-common
- Description: In case of index update database notification channel, indicates maximum redelivery attempts when an exception occurs.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 60
- Since: 6.8.4.7
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
defaultCommentClassName
- Module: cmas-core-server
- Description: Default text class name for comments.
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Example value:
- Since: 6.3.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
defaultIncommingMailClassName
- Module: cmas-core-server
- Description: Default text class name for incoming emails.
- Type: string
- Restart required: no
- System: no
- Optional: yes
- 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
defaultOutgoingMailClassName
- Module: cmas-core-server
- Description: Default text class name for outgoing emails.
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Example value:
- Since: 6.3.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 ticket administration.
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: true
- Since: 6.9.4.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. Default is true.
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
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)
- Since: 6.10.5.6
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
dwh.administration.refresh.interval.seconds
- Module: cmas-app-admin-tool
- Description: Internal DWH property, not to be changed manually.
- Type: integer
- Restart required: no
- System: yes
- Optional: yes
- Example value: 10
- Since: 6.11.0.1
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
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: false
- 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. Default engineer description template name.
- Type: String
- Restart required: no
- System: no
- Optional: no
- Since: 6.11.0
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
- Since: 6.4.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
- Since: 6.4.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
- Since: 6.4.0
expert.mode
- Module: cmas-core-shared
- Description: Switches expert mode on/off thereby unblocking/blocking expert features. E.g., only in expert mode, the CM system property initialized will be available.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: false
- Since: 6.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
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
fetchLock.interval
- Module: cmas-workflow-jbpm
- Description:
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 5000
- Removed in: 6.8.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
filesystem.polling.threads.number
- Module: cmas-nimh
- Description: Number of threads started for db emails' queue polling. Default: 1
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 10
- Since: 6.4.0
filesystem.polling.threads.shutdown.timeout.seconds
- Module: cmas-nimh
- Description: Waiting time after the shutdown signal. When the timeout reached, thread will be terminated. Default: 60
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
filesystem.polling.threads.watchdog.interval.seconds
- Module: cmas-nimh
- Description: Watchdog thread interval. Default: 30
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
filesystem.task.enabled
- Module: cmas-nimh
- Description: With this property service thread related to given poller can be disabled. Default: true
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: true
- Since: 6.4.0
filesystem.task.interval.seconds
- Module: cmas-nimh
- Description: Default interval for polling mailboxes. Default: 60 seconds
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
filesystem.task.polling.folder
- Module: cmas-nimh
- Description: Polling folder location which will be scanned for emails in the format of eml files. Default: "mail" subdir of cmas data directory
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Example value: c://cmas//mail
- Since: 6.4.0
filesystem.task.timeout.seconds
- Module: cmas-nimh
- Description: After this time (of inactivity) the service thread is considered as damaged and automatically restarted. Default: 120 seconds
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
filesystem.task.transaction.timeout.seconds
- Module: cmas-nimh
- Description: Default transaction timeout for email fetching transactions. Should be correlated with number of messages fetched at once. Default: 60 seconds
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
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)
- 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
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
helpFilePath
- Module: cmweb-server-adapter
- Description: URL for online help. If not empty, Help button is displayed in Web Client.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: http://www.consol.de
- Since: 6.2.1
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
hideTicketSubject
- Module: cmweb-server-adapter
- Description: If set to true, ticket subject is hidden.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: false
- Since: 6.2.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
index.attachment
- Module: cmas-core-index-common
- Description: Specifies whether content of attachments is indexed.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: true
- Since: 6.4.3
index.history
- Module: cmas-core-index-common
- Description: Specifies whether unit and ticket history are indexed.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: false
- Since: 6.1.0
- Removed in: 6.11.0
index.status
- Module: cmas-core-index-common
- Description: Status of the Indexer, possible values RED, YELLOW, GREEN, will be displayed in the Admin Tool.
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: GREEN
- Since: 6.6.1
index.task.worker.threads
- Module: cmas-core-index-common
- Description: How many threads will be used to execute index tasks (synchronization, administrative, and repair tasks).
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 1 (default) (we recommend to use a value not larger than 2)
- Since: 6.6.14, 6.7.3. Since 6.8.0 and exclusively in 6.6.21 also normal (live) index updates are affected by this property.
index.version.current
- Module: cmas-core-index-common
- Description: Holds information about current (possibly old) index version.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 1 (default)
- Since: 6.7.0
index.version.newest
- Module: cmas-core-index-common
- Description: Holds information about which index version is considered newest.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 1 (default)
- Since: 6.7.0
indexed.assets.per.thread.in.memory
- Module: cmas-core-index-common
- Description: How many assets should be loaded into memory at once, per thread, during indexing.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 200 (default)
- Since: 6.8.0
indexed.engineers.per.thread.in.memory
- Module: cmas-core-index-common
- Description: How many engineers should be loaded into memory at once, per thread, during indexing.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 300 (default)
- Since: 6.6.14, 6.7.3
indexed.resources.per.thread.in.memory
- Module: cmas-core-index-common
- Description: How many resources should be loaded into memory at once, per thread, during indexing.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 200 (default)
- Since: 6.10.0.0
indexed.tickets.per.thread.in.memory
- Module: cmas-core-index-common
- Description: How many tickets should be loaded into memory at once, per thread, during indexing.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 100 (default)
- Since: 6.6.14, 6.7.3
indexed.units.per.thread.in.memory
- Module: cmas-core-index-common
- Description: How many units should be loaded into memory at once, per thread, during indexing.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 200 (default)
- Since: 6.6.14, 6.7.3
initialized
- Module: cmas-setup-manager
- Description: Flag if CMAS is initialized. If this value is missing or not true, set-up 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 set-up at the next start, i.e. all data of the existing system is lost, including system properties!!!
internal.line.access.prefix
- Module: cmas-core-server
- Description: Prefix that the company’s telephony system asks 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
is.cmrf.alive
- Module: cmas-dwh-server
- Description: As a starting point, the time the last message was sent to CMRF should be used. If a response from CMRF is not received after value (in seconds), it should create a DWH operation status with an error message indicating that CMRF is down.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 1200
- Since: 6.7.0
java.naming.factory.initial
- Module: cmas-dwh-server
- Description: Factory class for the DWH context factory.
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: org.jnp.interfaces.NamingContextFactory
- Since: 6.0.1
- Removed in: 6.11.0.0
java.naming.factory.url.pkgs
- Module: cmas-dwh-server
- Description:
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: org.jboss.naming:org.jnp.interfaces
- Since: 6.0.1
- Removed in: 6.11.0.0
java.naming.provider.url
- Module: cmas-dwh-server
- Description: URL of naming provider.
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: localhost
- Since: 6.0.1
- Removed in: 6.11.0.0
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
- 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.idleInterval.seconds
- Module: cmas-workflow-engine
- Description: Determines how often job executor thread will look for new jobs to execute.
- Type: integer
- Restart required: no
- System: yes
- Optional: yes
- Example value: 45 (default up to CM version 6.10.5.2. Default CM versions 6.10.5.3 and up is 5)
- Since: 6.8.0
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.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)
- Since: 6.8.0
jobExecutor.jobMaxRetriesReachedSubject
- Module: cmas-workflow-engine
- Description: The subject used in the notification mail admins receive about failed job executors.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: Job maximum retries reached. Job was removed!!! (default)
- Since: 6.8.0
jobExecutor.lockingLimit
- Module: cmas-workflow-engine
- Description: Number of jobs locked at once (marked for execution) by job executor thread.
- Type: integer
- Restart required: no
- System: yes
- Optional: yes
- Example value: 5 (default since CM version 6.10.5.3)
- Since: 6.8.0
jobExecutor.lockTimeout.seconds
- Module: cmas-workflow-engine
- Description: How long the job can be locked (marked for execution) by job executor.
- Type: integer
- Restart required: no
- System: yes
- Optional: yes
- Example value: 360 (default)
- Since: 6.8.0
jobExecutor.mailFrom
- Module: cmas-workflow-engine
- Description: Email which will be set as From header during admin notifications.
- 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. Default value is set to 30 minutes
- Example value: 15 (default)
- 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)
- Since: 6.8.0
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
jobExecutor.timerRetryInterval.seconds
- Module: cmas-workflow-engine
- Description: Determines how long 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. Default 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)
- Since: 6.8.0
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 if Kerberos was not enabled during system set-up)
- 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
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
last.ping.timestamp
- Module: cmas-dwh-server
- Description: Internal DWH property, not to be changed manually.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: 32323214
- Since: 6.11.0.1
ldap.authentication
- Module: cmas-core-security
- Description: Authentication method used when using LDAP authentication. Possible values are 'anonymous' and 'simple' (default).
- Type: string
- Restart required: yes
- System: yes
- Optional: no
- Example value: simple
- Since: 6.0
ldap.basedn
- Module: cmas-core-security
- Description: Base DN used for looking up LDAP user accounts when using LDAP authentication.
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: ou=accounts,dc=consol,dc=de
- Since: 6.0
ldap.certificate.basedn
- Module: cmas-core-server
- Description: Base DN for certificates location in the LDAP tree. If not provided, cmas-core-security, ldap.basedn is used.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: ou=accounts,dc=consol,dc=de
- Since: 6.8.4
ldap.certificate.content.attribute
- Module: cmas-core-server
- Description: LDAP attribute name used where certificate data is stored in the LDAP tree. Default value: usercertificate
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: usercertificate
- Since: 6.8.4
ldap.certificate.password
- Module: cmas-core-server
- Description: LDAP Certificates manager password. If not set, cmas-core-security, ldap.password is used.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Since: 6.8.4
ldap.certificate.providerurl
- Module: cmas-core-server
- Description: LDAP Certificates provider URL. If not set, cmas-core-security, ldap.providerurl is used.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: ldap://ldap.consol.de:389
- Since: 6.8.4
ldap.certificate.searchattr
- Module: cmas-core-server
- Description: LDAP attribute name used to search for certificate in the LDAP tree. Default value: mail
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: mail
- Since: 6.8.4
ldap.certificate.userdn
- Module: cmas-core-server
- Description: LDAP Certificates manager DN. If not set, cmas-core-security, ldap.userdn is used.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Since: 6.8.4
ldap.contact.name.basedn
- Module: cmas-core-security
- Description: Base path to search for contact DN by LDAP ID (e.g. ou=accounts,dc=consol,dc=de).
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Since: 6.9.3.0
ldap.contact.name.password
- Module: cmas-core-security
- Description: Password to look up contact DN by LDAP ID. If not set, the anonymous account is used.
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Since: 6.9.3.0
ldap.contact.name.providerurl
- Module: cmas-core-security
- Description: Address of the LDAP server (ldap[s]://host:port).
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Since: 6.9.3.0
ldap.contact.name.searchattr
- Module: cmas-core-security
- Description: Attribute to search for contact DN by LDAP ID (e.g. uid).
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Since: 6.9.3.0
ldap.contact.name.userdn
- Module: cmas-core-security
- Description: User DN to look up contact DN by LDAP ID. If not set, the anonymous account is used.
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Since: 6.9.3.0
ldap.initialcontextfactory
- Module: cmas-core-security
- Description: Class name for the initial context factory of the LDAP implementation when using LDAP authentication. If it is not set, com.sun.jndi.ldap.LdapCtxFactory is used.
- Type: string
- Restart required: yes
- System: yes
- Optional: no
- Example value: com.sun.jndi.ldap.LdapCtxFactory
- Since: 6.0
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
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
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.attachments.validation.info.sender
- Module: cmas-nimh-extension
- Description: Sets From header of attachments type error notification mail
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: admin@mail.com
- Since: 6.7.5
mail.attachments.validation.info.subject
- Module: cmas-nimh-extension
- Description: Sets subject of attachments type error notification mail.
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: 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)
- Since: 6.8.5.5
mail.encryption
- Module: cmas-core-server
- Description: If property is set to true, the encrypt checkbox in the Ticket Email Editor is checked by default.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: true (default = false)
- Since: 6.8.4.0
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.from
- Module: cmweb-server-adapter
- Description: Use this address if set instead of engineer email address during email conversation.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Since: 6.1.2
mail.notification.engineerChange
- Module: cmas-core-server
- Description: 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.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. Default: true
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: false
- Since: 6.4.0
mail.process.error
- Module: cmas-nimh-extension
- Description: To address for error emails from Mule.
- Type: email
- Restart required: no
- System: yes
- Optional: no
- Example value: myuser@consol.de
- Since: 6.4.0
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.reply.to
- Module: cmweb-server-adapter
- Description: When set, Web Client will display Reply-To field on email send, prefilled with this value.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Since: 6.0.1
Please read the detailed information about ConSol CM Reply-To addresses in section Scripts of Type Email in the ConSol CM Administrator Manual.
mail.sender.address
- Module: cmas-workflow-jbpm
- Description: From address for emails from the workflow engine.
- Type: string
- Restart required: no
- System: yes
- Optional: no
- Example value: myuser@consol.de
- Removed in: 6.8.0
- Replaced by: jobExecutor.mailFrom
mail.smtp.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.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
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
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: string
- Restart required: no
- System: no
- Optional: yes
- Example value: consol
- Since: 6.4.0
mailbox.default.connection.port
- Module: cmas-nimh
- Description: Port for a given mailbox from which the poller reads 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: Example javax.mail property - allows for more detailed javax.mail session debugging
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: true
- Since: 6.4.0
mailbox.default.session.mail.imap.timeout
- Module: cmas-nimh
- Description: Example javax.mail property
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 120
- Since: 6.4.0
mailbox.default.session.mail.mime.address.strict
- Module: cmas-nimh
- Description: Example javax.mail property - counterpart of the old mule mail.mime.strict, allows to set not so strict email header parsing
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: true
- Since: 6.4.0
mailbox.default.session.mail.pop3.timeout
- Module: cmas-nimh
- Description: Example javax.mail property.
- Type:
- Restart required:
- System:
- Optional:
- Example value:
- Since: 6.4.0
mailbox.default.session.mail.PROTOCOL.fetchsize
- Module: cmas-nimh
- Description: Sets java mail property for partialfetch size 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
mailbox.default.session.mail.PROTOCOL.partialfetch
- Module: cmas-nimh
- Description: Sets java mail property for partialfetch i.e. controls whether the protocol 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:
- Since: 6.9.4.0
mailbox.default.task.delete.read.messages
- Module: cmas-nimh
- Description: This defines whether messages should be removed from the mailbox after processing. For IMAP protocol messages are marked as SEEN by default. For POP3 protocol, when flag is set to true the message is removed, otherwise remains on server and will result in infinite reads. Default: false.
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: false
- Since: 6.4.0
mailbox.default.task.enabled
- Module: cmas-nimh
- Description: With this property service thread related to given poller can be disabled. Default: true
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: false
- Since: 6.4.0
mailbox.default.task.interval.seconds
- Module: cmas-nimh
- Description: Default interval for polling mailboxes. Default: 60 seconds
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
mailbox.default.task.max.message.size
- Module: cmas-nimh
- Description: Maximum size of 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 in the ConSol CM Administrator Manual). From there they can be resent, downloaded to the file system, or deleted. For those operations the message size is not relevant. Default is set to 10MB: 10485760
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 10485760
- Since: 6.4.0
mailbox.default.task.max.messages.per.run
- Module: cmas-nimh
- Description: Number of messages fetched at once from mailbox. Must be correlated with transaction timeout. Default set to: 20
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
mailbox.default.task.timeout.seconds
- Module: cmas-nimh
- Description: After this time (of inactivity) the service thread is considered as damaged and automatically restarted. Default: 120 seconds
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
mailbox.default.task.transaction.timeout.seconds
- Module: cmas-nimh
- Description: Default transaction timeout for email fetching transactions. Should be correlated with number of messages fetched at once. Default: 60 seconds
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
mailbox.polling.threads.mail.log.enabled
- Module: cmas-nimh
- Description: Enables 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)
- Since: 6.9.4.1
mailbox.polling.threads.number
- Module: cmas-nimh
- Description: Number of threads for accessing mailboxes. Default: 1
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 1
- Since: 6.4.0
mailTemplateAboveQuotedText
- Module: cmweb-server-adapter
- Description: Indicates behavior of 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
max.licences.perUser
- Module: cmas-core-server
- Description: Sets maximum licenses 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
maxSizePerPagemapInMegaBytes
- Module: cmweb-server-adapter
- Description: The parameter defines the size (in MB) if 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
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 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
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
- 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
- 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
- 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
- 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
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
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
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
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). In case you would like to have the engineer change his/her password asap, use one of the two following values:
- 0
The engineer will be forced to change his/her password on the next login. - 1
The engineer will be forced to change his/her password the next day.
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 5500 (15 years, default)
- Since: 6.10.1.0
policy.password.pattern
- Module: cmas-core-security
- Description: Defines password pattern.
- Type: string
- Restart required: no
- System: no
- Optional: yes
- Example value: "^.3,$" (default)
- Since: 6.10.1.0
policy.rotation.ratio
- Module: cmas-core-security
- Description: Defines how often password may repeat. E.g., setting the value to X means that the new password cannot be present among the user's X previous passwords.
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 1 (default)
- 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)
- Since: 6.11.0.0
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)
- Since: 6.10.1.0
postActivityExecutionScriptName
- Module: cmweb-server-adapter
- Description: Defines the name for the script which should be executed after every workflow activity, see section PostActivityExecutionScript in the ConSol CM Administrator Manual. 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
queue.polling.threads.number
- Module: cmas-nimh
- Description: Number of threads started for emails' queue polling. Default: 1
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 1
- Since: 6.4.0
queue.polling.threads.shutdown.timeout.seconds
- Module: cmas-nimh
- Description: Waiting time after the shutdown signal. When the timeout is reached, the thread will be terminated. Default: 60
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.0
queue.polling.threads.watchdog.interval.seconds
- Module: cmas-nimh
- Description: Watchdog thread interval. Default: 30
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 30
- Since: 6.4.0
queue.task.error.pause.seconds
- Module: cmas-nimh
- Description: Maximum number of seconds, the queue poller waits after infrastructure (e.g. database) error. Default 180 seconds
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 180
- Since: 6.4.0
queue.task.interval.seconds
- Module: cmas-nimh
- Description: Main emails' queue polling thread interval. Default: 15
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 15
- Since: 6.4.0
queue.task.max.retries
- Module: cmas-nimh
- Description: Maximum number of 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) the service thread is considered as damaged and automatically restarted. Default: 600 seconds
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 600
- Since: 6.4.0
queue.task.transaction.timeout.seconds
- Module: cmas-nimh
- Description: Transaction timeout for email processing in the pipe. Default: 60
- Type: integer
- Restart required: no
- System: no
- Optional: yes
- Example value: 60
- Since: 6.4.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
- Since: 6.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 false - prevents storing new recent items.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: true
- Since: 6.11.1.0
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
refreshTimeInCaseOfConcurrentRememberMeRequests
- Module: cmas-workflow-jbpm
- Description: It sets the refresh time (in seconds) after which 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
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
resetCode.expiriationPeriod
- 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, 24 hours)
- Since: 6.10.1
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
scene
- Module: cmas-setup-scene
- Description: Scene file which was imported during set-up (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
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
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)
- Since: 6.11.0.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 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
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)
- 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)
- Since: 6.9.2.14
serial.mods.tracking.enabled
- Type: boolean
- Restart required: no
- System: no
- Optional: yes
- Example value: false (default)
- Since: 6.10.7.0, 6.11.0.5
server.session.archive.reaper.interval
- Module: cmas-core-server
- Description: Server archived sessions reaper interval (in seconds).
- 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 DB.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 31
- Since: 6.7.1
server.session.reaper.interval
- Module: cmas-core-server
- Description: Server inactive (ended) sessions reaper interval (in seconds).
- Type: integer
- Restart required: only Session Service
- System: yes
- Optional: no
- Example value: 60
- Since: 6.6.1, 6.7.1
server.session.timeout
- Module: cmas-core-server
- Description: Server session timeout (in seconds) for connected clients. Each client can overwrite this timeout with custom value using its ID (ADMIN_TOOL, WEB_CLIENT, WORKFLOW_EDITOR, TRACK (before 6.8, please use PORTER), ETL, REST) appended to property name, e.g., server.session.timeout.ADMIN_TOOL.
Please see also the Page Customization attributes updateTimeServerSessionActivityEnabled and updateTimeServerSessionActivity, both of type cmApplicationCustomization.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 1800
- Since: 6.6.1, 6.7.1
Detailed explanation for the Admin Tool:
- server.session.timeout.ADMIN_TOOL
Defines the time interval how long the server considers a session valid while there is no activity from the Admin Tool holding the session. The Admin Tool is not aware of this value, it only suffers having an invalid session, if the last activity has been longer in the past.
- admin.tool.session.check.interval
Defines the time between two checks done by the Admin Tool, if the server still considers its session valid.
For example, if admin.tool.session.check.interval = 60 the Admin Tool queries the server every minute if its session is still active/valid. In case server.session.timeout.ADMIN_TOOL = 600 the Admin Tool will get the response that the session is now invalid after ten minutes of inactivity.
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
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
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)
- 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)
- Since: 6.10.5.5
split.history
- Module: cmas-dwh-server
- Description: Changes the SQL that fetches the history for the tickets during DWH transfer not to all tickets at once but only for one ticket per SQL.
- Type: boolean
- Restart required: no
- System: yes
- Optional: yes
- Example value: false
- Since: 6.8.0
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
statistics.calendar
- Module: cmas-dwh-server
- Description: Internal DWH property, not to be changed manually.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: 0
- Since: 6.11.0.1
strict.utf.bmp.enabled
- Module: cmas-core-server
- Description: In ConSol CM versions lower than 6.10.6, incoming emails with a subject line containing four-byte UTF8 characters could not be handled by some installations using the MySQL database engine. The reason is the encoding/collation configuration of the database using a two-byte BMP (Basic Multilingual Plane) 0 plane which cannot be changed in some installations for technical reasons. Other database engines were unaffected. Emails with this encoding could not be imported into the system at all in CM versions lower than 6.10.6. In order to accommodate this issue this system property for configuration is available.
Setting it to true will filter out all four-byte UTF8 characters before any database interaction, so the problems mentioned above will not occur.
The property value is true by default for MySQL databases, and false for any other database where it should not be necessary at all. Change it for a MySQL database only, if the settings positively will support four-byte characters.
- Type: boolean
- Restart required: no
- System: yes
- Optional: no
- Example value: 100
- Since: 6.10.6.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
synchronize.master.address
- Module: cmas-core-index-common
- Description: Value of -Dcmas.http.host.port specifying how to connect to the indexing master server. Default null. Since 6.6.17 this value is configurable in set-up to designate the initial indexing master server. Please note that changing this value is only allowed when all cluster nodes' index change receivers are stopped.
- Type: integer
- Restart required: no
- System: yes
- Optional: yes
- Example value: 127.0.0.1:80
- Since: 6.6.0
synchronize.master.security.token
- Module: cmas-core-index-common
- Description: The password for accessing the index snapshot via URL, e.g., for index synchronization or for backups.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: token
- Since: 6.6.0
synchronize.master.security.user
- Module: cmas-core-index-common
- Description: The user name for accessing the index snapshot via URL, e.g., for index synchronization or for backups.
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: user
- Since: 6.6.0
synchronize.master.timeout.minutes
- Module: cmas-core-index-common
- Description: How long the master server may continually fail until a new master gets elected. Default 5. Since 6.6.17 this value is configurable in set-up, where zero means that master server will never change (failover is disabled).
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 5
- Since: 6.6.0
synchronize.megabits.per.second
- Module: cmas-core-index-common
- Description: How much bandwidth the master server may consume when transferring index changes to all slave servers. Default 85. Please do not use all available bandwidth to transfer index changes between hosts, as doing so will most probably partition the cluster due to some subsystems being unable to communicate.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 85
- Since: 6.6.0
synchronize.sleep.millis
- Module: cmas-core-index-common
- Description: How often each slave server polls the master server for index changes. Default 1000.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 1000
- Since: 6.6.0
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
task.execution.node.id
Module: cmas-core-serverDescription: Only relevant in clustered environments. The id of the node where scripts of the TEF (Task Execution Framework) which are run automatically will be executed. (Scripts which are started manually using the Admin Tool will be run on the machine where the Admin Tool is running.)
Type: Integer
Restart required: no
System: no
Optional: no
Example value: 2
Since: 6.11.0.1
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!)
themeOverlay
- Module: cmweb-server-adapter
- Description: Name of used theme overlay
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: consolINT
- Since: 6.0
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!
ticketListRefreshIntervalInSeconds
- Module: cmweb-server-adapter
- Description: Refresh interval for 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
tickets.delete.size
- Module: cmas-core-server
- Description: Defines a number of tickets deleted per transaction. By default it is set to 10.
- Type: integer
- Restart required: only Session Service
- System: yes
- Optional: no
- Example value: 10
- Since: 6.8.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
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*3600 (10 hours - default)
- Since: 6.10
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)
- Since: 6.11
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 (seconds) of a unit replacement action step.
- Type: integer
- Restart required: no
- System: yes
- Optional: no
- Example value: 120
- Since: 6.8.2
unit.transfer.order
- Module: cmas-dwh-server
- Description: Define 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
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
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 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: 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
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
urlLogoutPath
- Module: cmweb-server-adapter
- Description: URL which is used when user logs out. (If no value is set, logout leads to login-mask.)
- Type: string
- Restart required: no
- System: yes
- Optional: yes
- Example value: http://intranet.consol.de
- Since: 6.3.1
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
Notes:
- Since ConSol CM version 6.11.1.1, the default value is true for non-clustered environments. The value is set to true automatically during the setup or update of ConSol CM 6.11.1.1.
- When voCaching is enabled and lazy loading is used for folding ticket history entries, once the engineer unfolded an entry, he cannot fold it again by reloading the page or opening the ticket from the workspace.
- When using the dynamic mode for displaying engineer and customer names in the ticket history (as configured in the system properties cmas-core-server, engineer.description.mode and cmas-core-server, unit.description.mode), the new version of the engineer and/or customer name is only displayed after the ticket has been changed.
- This system property is ignored for clustered environments (environments with cmas-core-shared, cluster.mode set to true). In clustered environments, voCaching is always disabled to avoid problems that changes made to objects on one node are not visible on the other nodes.
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
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
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
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
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